diff --git a/4.18_commands.xml b/4.18_commands.xml new file mode 100644 index 0000000..2f2e5d8 --- /dev/null +++ b/4.18_commands.xml @@ -0,0 +1,115526 @@ + + + listResourceIcon + Lists the resource icon for the specified resource(s) + false + 4.16.0.0 + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + base64image + base64 representation of resource icon + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + resourceobjecttype + + + false + + + createVPCOffering + Creates VPC offering + true + + + displaytext + the display text of the vpc offering + true + string + + + name + the name of the vpc offering + true + string + + + supportedservices + services supported by the vpc offering + true + list + list + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + enable + set to true if the offering is to be enabled during creation. Default is false + false + 4.16 + boolean + + + internetprotocol + The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6 + false + 4.17.0 + string + + + servicecapabilitylist + desired service capabilities as part of vpc offering + false + map + 4.4 + map + + + serviceofferingid + the ID of the service offering for the VPC router appliance + false + uuid + + + serviceproviderlist + provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network + false + map + map + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + ldapCreateAccount + Creates an account from an LDAP user + false + 4.2.0 + + + username + Unique username. + true + string + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accountid + Account UUID, required for adding account from external provisioning system + false + string + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + Creates the user under the specified domain. + false + uuid + + + networkdomain + Network domain for the account's networks + false + string + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + createPod + Creates a new Pod. + false + + + name + the name of the Pod + true + string + + + zoneid + the Zone ID in which the Pod will be created + true + uuid + + + allocationstate + Allocation state of this Pod for allocation of new resources + false + string + + + endip + the ending IP address for the Pod + false + string + + + gateway + the gateway for the Pod + false + string + + + netmask + the netmask for the Pod + false + string + + + startip + the starting IP address for the Pod + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + removeRawUsageRecords + Safely removes raw records from cloud_usage table + false + 4.6.0 + + + interval + 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 + true + integer + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + copyIso + Copies an iso from one zone to another. + true + + + id + Template ID. + true + uuid + + + destzoneid + ID of the zone the template is being copied to. + false + uuid + + + destzoneids + 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. + false + list + list + + + sourcezoneid + 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. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteAutoScaleVmProfile + Deletes a autoscale vm profile. + true + + + id + the ID of the autoscale profile + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + provisionCertificate + Issues and propagates client certificate on a connected host/agent using configured CA plugin + true + 4.11.0 + + + hostid + The host/agent uuid to which the certificate has to be provisioned (issued and propagated) + true + uuid + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + reconnect + Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVirtualMachinesMetrics + Lists VM metrics + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + clusterid + the cluster ID + false + uuid + + + details + 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 + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hostid + the host ID + false + uuid + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + storageid + the storage ID where vm's volumes belong to + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + cputotal + the total cpu capacity in Ghz + string + + + diskiopstotal + the total disk iops + long + + + diskread + disk read in MiB + string + + + diskwrite + disk write in MiB + string + + + ipaddress + the VM's primary IP address + string + + + memorytotal + the total memory capacity in GiB + string + + + networkread + network read in MiB + string + + + networkwrite + network write in MiB + string + + + false + + + listHosts + Lists hosts. + false + + + clusterid + lists hosts existing in particular cluster + false + uuid + + + details + comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats] + false + list + list + + + hahost + if true, list only hosts dedicated to HA + false + boolean + + + hypervisor + hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator + false + string + + + id + the id of the host + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the host + false + string + + + outofbandmanagementenabled + list hosts for which out-of-band management is enabled + false + boolean + + + outofbandmanagementpowerstate + list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown] + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID for the host + false + uuid + + + resourcestate + 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] + false + string + + + state + the state of the host + false + string + + + type + the host type + false + string + + + virtualmachineid + lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM + false + uuid + + + zoneid + the Zone ID for the host + false + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + hypervisortype + + + hypervisorversion + the hypervisor version + string + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteStoragePool + Deletes a storage pool. + false + + + id + Storage pool id + true + uuid + + + forced + Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal) + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVsphereStoragePolicyCompatiblePools + List storage pools compatible with a vSphere storage policy + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + policyid + ID of the storage policy + false + uuid + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + name + the name of the storage pool + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteGuestNetworkIpv6Prefix + Deletes an existing guest network IPv6 prefix. + true + 4.17.0.0 + + + id + Id of the guest network IPv6 prefix + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateStoragePool + Updates a storage pool. + false + 3.0.0 + + + id + the Id of the storage pool + true + uuid + + + capacitybytes + bytes CloudStack can provision from this storage pool + false + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + false + long + + + enabled + false to disable the pool for allocation of new volumes, true to enable it back. + false + boolean + + + name + Change the name of the storage pool + false + 4.15 + string + + + tags + comma-separated list of tags for the storage pool + false + list + list + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + name + the name of the storage pool + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTungstenFabricTag + Lists Tungsten-Fabric tags + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + keyword + List by keyword + false + string + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + nicuuid + tthe uuid of Tungsten-Fabric nic + false + string + + + page + false + integer + + + pagesize + false + integer + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + taguuid + the uuid of Tungsten-Fabric tag + false + string + + + vmuuid + the uuid of Tungsten-Fabric vm + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + rebootSystemVm + Reboots a system VM. + true + + + id + The ID of the system virtual machine + true + uuid + + + forced + Force reboot the system VM (System VM is Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + importLdapUsers + Import LDAP users + false + 4.3.0 + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + 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 + false + uuid + + + group + Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported. + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + listNetworks + Lists all available networks. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + acltype + list networks by ACL (access control list) type. Supported values are account and domain + false + string + + + associatednetworkid + List networks by associated networks. Only available if create a Shared network. + false + 4.17.0 + uuid + + + canusefordeploy + list networks available for VM deployment + false + boolean + + + displaynetwork + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvpc + the network belongs to VPC + false + boolean + + + id + list networks by ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issystem + true if network is system, false otherwise + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkfilter + possible values are "account", "domain", "accountdomain","shared", and "all". Default value is "all".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared). + false + 4.17.0 + string + + + networkofferingid + list networks by network offering ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + list networks by physical network id + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + restartrequired + list networks by restartRequired + false + boolean + + + showicon + flag to display the resource icon for networks + false + boolean + + + specifyipranges + true if need to list only networks which support specifying IP ranges + false + boolean + + + supportedservices + list networks supporting certain services + false + list + list + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + type of the traffic + false + string + + + type + the type of the network. Supported values are: isolated, l2, shared and all + false + string + + + vlan + the ID or VID of the network + false + 4.17.0 + string + + + vpcid + List networks by VPC + false + uuid + + + zoneid + the zone ID of the network + false + uuid + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listDedicatedZones + List dedicated zones. + false + + + account + the name of the account associated with the zone. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated zones by affinity group + false + uuid + + + domainid + the ID of the domain associated with the zone + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of the Zone + false + uuid + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Zone is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the zone + string + + + domainid + the domain ID to which the Zone is dedicated + string + + + zoneid + the ID of the Zone + string + + + zonename + the Name of the Zone + string + + + false + + + listElastistorPool + Lists the pools of elastistor + false + + + id + the ID of the Pool + false + long + + + + + id + the ID of the storage pool + string + + + controllerid + controller of the pool + string + + + gateway + default gateway of the pool + string + + + maxiops + available iops of the pool + long + + + name + the name of the storage pool + string + + + size + the current available space of the pool + long + + + state + the state of the storage pool + string + + + false + + + releaseIpAddress + Releases an IP address from the account. + false + 4.17 + + + id + the ID of the public IP address to release + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updatePodManagementNetworkIpRange + Updates a management network IP range. Only allowed when no IPs are allocated. + true + 4.16.0.0 + + + currentendip + The current ending IP address. + true + string + + + currentstartip + The current starting IP address. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + newendip + The new ending IP address. + false + string + + + newstartip + The new starting IP address. + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricLBHealthMonitor + list Tungsten-Fabric LB health monitor + false + + + lbruleid + the ID of lb rule + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the health monitor ID + long + + + expectedcode + the health monitor expected code + string + + + httpmethod + the health monitor http method + string + + + interval + the health monitor interval + int + + + lbruleid + the LB rule ID + string + + + retry + the health monitor retry + int + + + timeout + the health monitor timeout + int + + + type + the health monitor type + string + + + urlpath + the health monitor url path + string + + + uuid + the health monitor UUID + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateFirewallRule + Updates firewall rule + true + 4.4 + + + id + the ID of the firewall rule + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + quotaIsEnabled + Return true if the plugin is enabled + false + 4.7.0 + + + + isenabled + is quota service enabled + boolean + + + false + + + quotaEmailTemplateList + Lists all quota email templates + false + 4.7.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + templatetype + List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY + false + string + + + + + last_updated + Last date/time when template was updated + date + + + locale + The quota email template locale + string + + + templatebody + The quota email template content + string + + + templatesubject + The quota email template subject + string + + + templatetype + Template type + string + + + false + + + deleteAccountFromProject + Deletes account from the project + true + 3.0.0 + + + account + name of the account to be removed from the project + true + string + + + projectid + ID of the project to remove the account from + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listHypervisors + List hypervisors + false + + + zoneid + the zone id for listing hypervisors. + false + uuid + + + + + name + Hypervisor name + string + + + false + + + listGuestVlans + Lists all guest vlans + false + 4.17.0 + + + allocatedonly + limits search results to allocated guest vlan. false by default. + false + boolean + + + id + list guest vlan by id + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + list guest vlan by physical network + false + uuid + + + vnet + list guest vlan by vnet + false + string + + + zoneid + list guest vlan by zone + false + uuid + + + + + id + the guest VLAN id + long + + + account + the account of the guest VLAN range + string + + + allocationstate + the allocation state of the guest VLAN + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + isdedicated + true if the guest VLAN is dedicated to the account + boolean + + + network + the list of networks who use this guest VLAN + list + + + physicalnetworkid + the physical network ID of the guest VLAN range + string + + + physicalnetworkname + the physical network name of the guest VLAN range + string + + + project + the project name of the guest VLAN range + string + + + projectid + the project id of the guest VLAN range + string + + + taken + date the guest VLAN was taken + date + + + vlan + the guest VLAN + string + + + zoneid + the zone ID of the guest VLAN range + string + + + zonename + the zone name of the guest VLAN range + string + + + false + + + updateGuestOs + Updates the information about Guest OS + true + 4.4.0 + + + id + UUID of the Guest OS + true + uuid + + + details + Map of (key/value pairs) + true + map + map + + + osdisplayname + Unique display name for Guest OS + true + string + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + isuserdefined + is the guest OS user defined + boolean + + + oscategoryid + the ID of the OS category + string + + + false + + + updateResourceLimit + Updates resource limits for an account or domain. + false + + + resourcetype + Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + true + integer + + + account + Update resource for a specified account. Must be used with the domainId parameter. + false + string + + + domainid + 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. + false + uuid + + + max + Maximum resource limit. + false + long + + + projectid + Update resource limits for project + false + uuid + + + + + account + the account of the resource limit + string + + + domain + the domain name of the resource limit + string + + + domainid + the domain ID of the resource limit + string + + + max + the maximum number of the resource. A -1 means the resource currently has no limit. + long + + + project + the project name of the resource limit + string + + + projectid + the project id of the resource limit + string + + + resourcetype + 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. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + false + + + deleteStaticRoute + Deletes a static route + true + + + id + the ID of the static route + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listHostsMetrics + Lists hosts metrics + false + 4.9.3 + + + clusterid + lists hosts existing in particular cluster + false + uuid + + + details + comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats] + false + list + list + + + hahost + if true, list only hosts dedicated to HA + false + boolean + + + hypervisor + hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator + false + string + + + id + the id of the host + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the host + false + string + + + outofbandmanagementenabled + list hosts for which out-of-band management is enabled + false + boolean + + + outofbandmanagementpowerstate + list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown] + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID for the host + false + uuid + + + resourcestate + 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] + false + string + + + state + the state of the host + false + string + + + type + the host type + false + string + + + virtualmachineid + lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM + false + uuid + + + zoneid + the Zone ID for the host + false + uuid + + + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedghz + the total cpu allocated in Ghz + string + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpuloadaverage + the average cpu load the last minute + double + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotalghz + the total cpu capacity in Ghz + string + + + cpuusedghz + the total cpu used in Ghz + string + + + instances + instances on the host + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedgb + the total memory allocated in GiB + string + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotalgb + the total memory capacity in GiB + string + + + memoryusedgb + the total memory used in GiB + string + + + networkread + network read in GiB + string + + + networkwrite + network write in GiB + string + + + powerstate + out-of-band management power state + powerstate + + + false + + + getLoadBalancerSslCertificate + get load balancer certificate + false + + + id + the ID of Lb + true + uuid + + + + + chain + chain + string + + + crt + crt + string + + + key + key + string + + + false + + + releaseDedicatedPod + Release the dedication for the pod + true + + + podid + the ID of the Pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAffinityGroups + Lists affinity groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list the affinity group by the ID provided + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + lists affinity groups by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + type + lists affinity groups by type + false + string + + + virtualmachineid + lists affinity groups by virtual machine ID + false + uuid + + + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + false + + + registerSSHKeyPair + Register a public key in a keypair under a certain name + false + + + name + Name of the keypair + true + string + + + publickey + Public key material of the keypair + true + string + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the ssh key. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the ssh key + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the keypair + string + + + domain + the domain name of the keypair owner + string + + + domainid + the domain id of the keypair owner + string + + + fingerprint + Fingerprint of the public key + string + + + name + Name of the keypair + string + + + project + the project name of the keypair owner + string + + + projectid + the project id of the keypair owner + string + + + false + + + startRollingMaintenance + Start rolling maintenance + true + + + clusterids + the IDs of the clusters to start maintenance on + false + list + list + + + forced + if rolling mechanism should continue in case of an error + false + boolean + + + hostids + the IDs of the hosts to start maintenance on + false + list + list + + + payload + the command to execute while hosts are on maintenance + false + string + + + podids + the IDs of the pods to start maintenance on + false + list + list + + + timeout + optional operation timeout (in seconds) that overrides the global timeout setting + false + integer + + + zoneids + the IDs of the zones to start maintenance on + false + list + list + + + + + details + in case of failure, details are displayed + string + + + success + indicates if the rolling maintenance operation was successful + boolean + + + hostsskipped(*) + the hosts skipped + + + hostid + the ID of the skipped host + string + + + hostname + the name of the skipped host + string + + + reason + the reason to skip the host + string + + + list + + + hostsupdated(*) + the hosts updated + + + enddate + end date of the update on the host + string + + + hostid + the ID of the updated host + string + + + hostname + the name of the updated host + string + + + output + output of the maintenance script on the host + string + + + startdate + start date of the update on the host + string + + + list + + + false + + + deleteRemoteAccessVpn + Destroys a l2tp/ipsec remote access vpn + true + + + publicipid + public ip address id of the vpn server + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricApplicationPolicySet + list Tungsten-Fabric application policy set + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + firewallpolicy + list Tungsten-Fabric firewall policy + list + + + name + Tungsten-Fabric policy name + string + + + tag + list Tungsten-Fabric tag + list + + + uuid + Tungsten-Fabric application policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateNetworkACLList + Updates network ACL list + true + 4.4 + + + id + the ID of the network ACL + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + description + Description of the network ACL list + false + string + + + fordisplay + an optional field, whether to the display the list to the end user or not + false + 4.4 + boolean + + + name + Name of the network ACL list + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + restoreVirtualMachine + Restore a VM to original template/ISO or new template/ISO + true + 3.0.0 + + + virtualmachineid + Virtual Machine ID + true + uuid + + + templateid + 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 + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteNiciraNvpDevice + delete a nicira nvp device + true + + + nvpdeviceid + Nicira device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteEvents + Delete one or more events. + false + + + enddate + end date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the events + false + list + list + + + startdate + start date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + delete by event type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + reserveIpAddress + Reserve a public IP to an account. + false + 4.17 + + + id + the ID of the public IP address to reserve + true + uuid + + + account + the account to reserve with this IP address + false + string + + + domainid + the ID of the domain to reserve with this IP address + false + uuid + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + boolean + + + projectid + the ID of the project to reserve with this IP address + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocatin, Allocated and Releasing + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachinename + virtual machine name the ip address is assigned to (not null only for static nat Ip) + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + getVolumeSnapshotDetails + Get Volume Snapshot Details + false + + + snapshotid + CloudStack Snapshot UUID + true + string + + + + + volumeiScsiName + Volume iSCSI Name + string + + + false + + + listUcsBlades + List ucs blades + false + + + ucsmanagerid + ucs manager id + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + ucs blade id + string + + + bladedn + ucs blade dn + string + + + hostid + cloudstack host id this blade associates to + string + + + profiledn + associated ucs profile dn + string + + + ucsmanagerid + ucs manager id + string + + + false + + + notifyBaremetalProvisionDone + Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user + true + + + mac + mac of the nic used for provision + true + object + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteIso + Deletes an ISO file. + true + + + id + the ID of the ISO file + true + uuid + + + zoneid + the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateHost + Updates a host. + false + + + id + the ID of the host to update + true + uuid + + + allocationstate + Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable + false + string + + + annotation + Add an annotation to this host + false + 4.11 + string + + + hosttags + list of tags to be added to the host + false + list + list + + + name + Change the name of host + false + 4.15 + string + + + oscategoryid + the id of Os category to update the host with + false + uuid + + + url + the new uri for the secondary storage: nfs://host/path + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + hypervisortype + + + hypervisorversion + the hypervisor version + string + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createEgressFirewallRule + Creates a egress firewall rule for a given network + true + + + networkid + the network id of the port forwarding rule + true + uuid + + + protocol + the protocol for the firewall rule. Valid values are TCP/UDP/ICMP. + true + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + destcidrlist + the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + startport + the starting port of firewall rule + false + integer + + + type + type of firewallrule: system/user + false + string + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listVPCOfferings + Lists VPC offerings + false + + + displaytext + list VPC offerings by display text + false + string + + + domainid + list VPC offerings available for VPC creation in specific domain + false + 4.18 + uuid + + + id + list VPC offerings by id + false + uuid + + + isdefault + true if need to list only default VPC offerings. Default value is false + false + boolean + + + keyword + List by keyword + false + string + + + name + list VPC offerings by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + state + list VPC offerings by state + false + string + + + supportedservices + list VPC offerings supporting certain services + false + list + list + + + zoneid + id of zone VPC offering is associated with + false + 4.13 + uuid + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + getSolidFireVolumeSize + Get the SF volume size including Hypervisor Snapshot Reserve + false + + + volumeid + Volume UUID + true + string + + + + + solidFireVolumeSize + SolidFire Volume Size Including Hypervisor Snapshot Reserve + long + + + false + + + uploadVolume + Uploads a data disk. + true + + + format + the format for the volume. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume + true + string + + + url + the URL of where the volume is hosted. Possible URL include http:// and https:// + true + string + + + zoneid + the ID of the zone the volume is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + checksum + the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + diskofferingid + the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown. + false + uuid + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + imagestoreuuid + Image store uuid + false + string + + + projectid + Upload volume for the project + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listSecurityGroups + Lists security groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list the security group by the id provided + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + securitygroupname + lists security groups by name + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + lists security groups by virtual machine id + false + uuid + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + configureOutOfBandManagement + Configures a host's out-of-band management interface + false + 4.9.0 + + + address + the host management interface IP address + true + string + + + driver + the host management interface driver, for example: ipmitool + true + string + + + hostid + the ID of the host + true + uuid + + + password + the host management interface password + true + string + + + port + the host management interface port + true + string + + + username + the host management interface user + true + string + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listStorageTags + Lists storage tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the storage tag + string + + + name + the name of the storage tag + string + + + poolid + the pool ID of the storage tag + long + + + false + + + deleteServicePackageOffering + Delete Service Package + false + + + id + the service offering ID + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTemplatePermissions + List template visibility and all accounts that have permissions to view this template. + false + + + id + the template ID + true + uuid + + + + + id + the template ID + string + + + account + the list of accounts the template is available for + list + + + domainid + the ID of the domain to which the template belongs + string + + + ispublic + true if this template is a public template, false otherwise + boolean + + + projectids + the list of projects the template is available for + list + + + false + + + listAnnotations + Lists annotations. + false + 4.11 + + + annotationfilter + possible values are "self" and "all". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access + false + 4.16.0 + string + + + entityid + the id of the entity for which to show annotations + false + string + + + entitytype + the entity type + false + string + + + id + the id of the annotation + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + userid + optional: the id of the user of the annotation + false + 4.16.0 + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + destroySystemVm + Destroys a system virtual machine. + true + + + id + The ID of the system virtual machine + true + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + addSwift + Adds Swift. + false + 3.0.0 + + + url + the URL for swift + true + string + + + account + the account for swift + false + string + + + key + key for the user for swift + false + string + + + username + the username for swift + false + string + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + archiveEvents + Archive one or more events. + false + + + enddate + end date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the events + false + list + list + + + startdate + start date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + archive by event type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSecondaryStagingStore + Deletes a secondary staging store . + false + 4.2.0 + + + id + the staging store ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUserData + List registered userdatas + false + 4.18 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the Userdata + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + Userdata name to look for + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the userdata + string + + + accountid + the owner id of the userdata + string + + + domain + the domain name of the userdata owner + string + + + domainid + the domain id of the userdata owner + string + + + name + Name of the userdata + string + + + params + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + string + + + userdata + base64 encoded userdata content + string + + + false + + + updateLoadBalancer + Updates an internal load balancer + true + 4.4.0 + + + id + the ID of the load balancer + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + scaleSystemVm + Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect. + true + + + id + The ID of the system vm + true + uuid + + + serviceofferingid + the service offering ID to apply to the system vm + true + uuid + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + listSnapshotPolicies + Lists snapshot policies. + false + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the snapshot policy + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + volumeid + the ID of the disk volume + false + uuid + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + false + + + updateVpnCustomerGateway + Update site to site vpn customer gateway + true + + + id + id of customer gateway + true + uuid + + + cidrlist + guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,). + true + string + + + esppolicy + ESP policy of the customer gateway + true + string + + + gateway + public ip address id of the customer gateway + true + string + + + ikepolicy + IKE policy of the customer gateway + true + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes. + true + string + + + account + the account associated with the gateway. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain. + false + uuid + + + dpd + If DPD is enabled for VPN connection + false + boolean + + + esplifetime + Lifetime of phase 2 VPN connection to the customer gateway, in seconds + false + long + + + forceencap + Force encapsulation for Nat Traversal + false + boolean + + + ikelifetime + Lifetime of phase 1 VPN connection to the customer gateway, in seconds + false + long + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike + false + 4.15.1 + string + + + name + name of this customer gateway + false + string + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + false + 4.15.1 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + applyTungstenFabricTag + apply Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + networkuuid + the uuid of networks + false + list + list + + + nicuuid + the uuid of nics + false + list + list + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + vmuuid + the uuid of vms + false + list + list + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + lockAccount + This deprecated function used to locks an account. Look for the API DisableAccount instead + false + + + account + Locks the specified account. + true + string + + + domainid + Locks the specified account on this domain. + true + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + stopRouter + Stops a router. + true + + + id + the ID of the router + true + uuid + + + forced + Force stop the VM. The caller knows the VM is stopped. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listClusters + Lists clusters. + false + + + allocationstate + lists clusters by allocation state + false + string + + + clustertype + lists clusters by cluster type + false + string + + + hypervisor + lists clusters by hypervisor type + false + string + + + id + lists clusters by the cluster ID + false + uuid + + + keyword + List by keyword + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + name + lists clusters by the cluster name + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists clusters by Pod ID + false + uuid + + + showcapacities + flag to display the capacity of the clusters + false + boolean + + + zoneid + lists clusters by Zone ID + false + uuid + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + createTungstenFabricFirewallPolicy + create Tungsten-Fabric firewall policy + true + + + name + Tungsten-Fabric firewall policy name + true + string + + + sequence + the sequence of Tungsten-Fabric firewall policy + true + integer + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + + + firewallrule + list Tungsten-Fabric firewall rule + list + + + name + Tungsten-Fabric firewall policy name + string + + + uuid + Tungsten-Fabric firewall policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + deleteProjectInvitation + Deletes project invitation + true + 3.0.0 + + + id + id of the invitation + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listProjectInvitations + Lists project invitations and provides detailed information for listed invitations + false + 3.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + activeonly + if true, list only active invitations - having Pending state and ones that are not timed out yet + false + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list invitations by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list by project id + false + uuid + + + state + list invitations by state + false + string + + + userid + list invitation by user ID + false + uuid + + + + + id + the id of the invitation + string + + + account + the account name of the project's owner + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + email + the email the invitation was sent to + string + + + project + the name of the project + string + + + projectid + the id of the project + string + + + state + the invitation state + string + + + userid + the User ID + string + + + false + + + listEgressFirewallRules + Lists all egress firewall rules for network ID. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the firewall services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + the network ID for the egress firewall services + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateRegion + Updates a region + false + + + id + Id of region to update + true + integer + + + endpoint + updates region with this end point + false + string + + + name + updates region with this name + false + string + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + deleteTrafficType + Deletes traffic type of a physical network + true + 3.0.0 + + + id + traffic type id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listClustersMetrics + Lists clusters metrics + false + 4.9.3 + + + allocationstate + lists clusters by allocation state + false + string + + + clustertype + lists clusters by cluster type + false + string + + + hypervisor + lists clusters by hypervisor type + false + string + + + id + lists clusters by the cluster ID + false + uuid + + + keyword + List by keyword + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + name + lists clusters by the cluster name + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists clusters by Pod ID + false + uuid + + + showcapacities + flag to display the capacity of the clusters + false + boolean + + + zoneid + lists clusters by Zone ID + false + uuid + + + + + cpuallocated + the total cpu allocated in Ghz + string + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpumaxdeviation + the maximum cpu deviation + string + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotal + the total cpu capacity in Ghz + string + + + cpuused + the total cpu used in Ghz + string + + + hosts + running / total hosts in the cluster + string + + + memoryallocated + the total cpu allocated in GiB + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorymaxdeviation + the maximum memory deviation + string + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotal + the total cpu capacity in GiB + string + + + memoryused + the total cpu used in GiB + string + + + state + state of the cluster + string + + + false + + + listProjectRolePermissions + Lists a project's project role permissions + false + 4.15.0 + + + projectid + ID of the project + true + uuid + + + projectroleid + ID of the project role + false + uuid + + + + + id + the ID of the project role permission + string + + + projectid + the ID of the project + string + + + projectroleid + the ID of the project role to which the role permission belongs + string + + + projectrolename + the name of the project role to which the role permission belongs + string + + + false + + + createBackupSchedule + Creates a user-defined VM backup schedule + false + 4.14.0 + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + schedule + custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + string + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + listLdapConfigurations + Lists all LDAP configurations + false + 4.2.0 + + + domainid + linked domain + false + uuid + + + hostname + Hostname + false + string + + + keyword + List by keyword + false + string + + + listall + If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain + false + 4.13.2 + boolean + + + page + false + integer + + + pagesize + false + integer + + + port + Port + false + integer + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port teh ldap server is running on + int + + + false + + + listSecondaryStagingStores + Lists secondary staging stores. + false + 4.2.0 + + + id + the ID of the staging store + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the staging store + false + string + + + page + false + integer + + + pagesize + false + integer + + + protocol + the staging store protocol + false + string + + + provider + the staging store provider + false + string + + + zoneid + the Zone ID for the staging store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + createRemoteAccessVpn + Creates a l2tp/ipsec remote access vpn + true + + + publicipid + public ip address id of the vpn server + true + uuid + + + account + an optional account for the VPN. Must be used with domainId. + false + string + + + domainid + an optional domainId for the VPN. If the account parameter is used, domainId must also be used. + false + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + iprange + the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server + false + string + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default + false + boolean + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + changeServiceForVirtualMachine + (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect. + false + + + id + The ID of the virtual machine + true + uuid + + + serviceofferingid + the service offering ID to apply to the virtual machine + true + uuid + + + automigrate + Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering + false + 4.17 + boolean + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + maxiops + New maximum number of IOPS for the custom disk offering + false + 4.17 + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + 4.17 + long + + + shrinkok + Verify OK to Shrink + false + 4.17 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + true + + + startRouter + Starts a router. + true + + + id + the ID of the router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listTemplates + List all public, private, and privileged templates. + false + + + templatefilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + details + comma separated list of template details requested, value can be a list of [ all, min] + false + list + 4.15 + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + the template ID + false + uuid + + + ids + the IDs of the templates, mutually exclusive with id + false + list + 4.9 + list + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the template name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parenttemplateid + list datadisk templates by parent template id + false + 4.4 + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the templates + false + boolean + + + showremoved + show removed templates as well + false + boolean + + + showunique + If set to true, list only unique templates across zones + false + 4.13.2 + boolean + + + tags + List resources by tags (key/value pairs) + false + map + map + + + zoneid + list templates by zoneId + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listGuestOsMapping + Lists all available OS mappings for given hypervisor + false + 4.4.0 + + + hypervisor + list Guest OS mapping by hypervisor + false + string + + + hypervisorversion + list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter + false + string + + + id + list mapping by its UUID + false + uuid + + + keyword + List by keyword + false + string + + + ostypeid + list mapping by Guest OS Type UUID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + resetConfiguration + Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings + false + 4.16.0 + + + name + the name of the configuration + true + string + + + accountid + the ID of the Account to reset the parameter value for corresponding account + false + uuid + + + clusterid + the ID of the Cluster to reset the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to reset the parameter value for corresponding domain + false + uuid + + + imagestoreid + the ID of the Image Store to reset the parameter value for corresponding image store + false + uuid + + + storageid + the ID of the Storage pool to reset the parameter value for corresponding storage pool + false + uuid + + + zoneid + the ID of the Zone to reset the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + deleteStratosphereSsp + Removes stratosphere ssp server + false + + + hostid + the host ID of ssp server + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createAutoScalePolicy + Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group. + true + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + true + string + + + conditionids + the list of IDs of the conditions that are being evaluated on every interval + true + list + list + + + duration + the duration in which the conditions have to be true before action is taken + true + integer + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + quiettime + the cool down period in which the policy should not be evaluated after the action has been taken + false + integer + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + createTungstenFabricPolicy + create Tungsten-Fabric policy + true + + + name + Tungsten-Fabric policy name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listUsageServerMetrics + Lists Usage Server metrics + false + 4.17.0 + + + + collectiontime + the time these statistics were collected + date + + + hostname + the name of the active usage server + string + + + lastheartbeat + the last time this Usage Server checked for jobs + date + + + lastsuccessfuljob + the last time a usage job successfully completed + date + + + state + the state of the usage server + state + + + false + + + listPhysicalNetworks + Lists physical networks + false + 3.0.0 + + + id + list physical network by id + false + uuid + + + keyword + List by keyword + false + string + + + name + search by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the Zone ID for the physical network + false + uuid + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + enableHAForZone + Enables HA for a zone + true + 4.11 + + + zoneid + ID of the zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + cleanVMReservations + Cleanups VM reservations in the database. + true + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteBrocadeVcsDevice + delete a Brocade VCS Switch + true + + + vcsdeviceid + Brocade Switch ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listFirewallRules + Lists all firewall rules for an IP address. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the firewall services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list firewall rules for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + extractIso + Extracts an ISO + true + + + id + the ID of the ISO file + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + url + the URL to which the ISO would be extracted + false + string + + + zoneid + the ID of the zone where the ISO is originally located + false + uuid + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + createSecondaryStagingStore + create secondary staging store. + false + + + url + the URL for the staging store + true + string + + + details + the details for the staging store + false + map + map + + + provider + the staging store provider name + false + string + + + scope + the scope of the staging store: zone only for now + false + string + + + zoneid + the Zone ID for the staging store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + createAffinityGroup + Creates an affinity/anti-affinity group + true + + + name + name of the affinity group + true + string + + + type + Type of the affinity group from the available affinity/anti-affinity group types + true + string + + + account + an account for the affinity group. Must be used with domainId. + false + string + + + description + optional description of the affinity group + false + string + + + domainid + domainId of the account owning the affinity group + false + uuid + + + projectid + create affinity group for project + false + uuid + + + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + false + + + removeVmwareDc + Remove a VMware datacenter from a zone. + false + + + zoneid + The id of Zone from which VMware datacenter has to be removed. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listInternalLoadBalancerElements + Lists all available Internal Load Balancer elements. + false + 4.2.0 + + + enabled + list internal load balancer elements by enabled state + false + boolean + + + id + list internal load balancer elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list internal load balancer elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + updateLBHealthCheckPolicy + Updates load balancer health check policy + true + 4.4 + + + id + ID of load balancer health check policy + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + removeTungstenFabricPolicyRule + remove Tungsten-Fabric policy + true + + + policyuuid + the Uuid of Tungsten-Fabric policy + true + string + + + ruleuuid + the Uuid of Tungsten-Fabric policy rule + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createTungstenFabricProvider + Create Tungsten-Fabric provider in cloudstack + false + + + name + Tungsten-Fabric provider name + true + string + + + tungstengateway + Tungsten-Fabric provider gateway + true + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + true + string + + + zoneid + the ID of zone + true + uuid + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + false + string + + + tungstenproviderport + Tungsten-Fabric provider port + false + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + false + string + + + + + name + Tungsten-Fabric provider name + string + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + tungstengateway + Tungsten-Fabric provider gateway + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + string + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + string + + + tungstenproviderport + Tungsten-Fabric provider port + string + + + tungstenprovideruuid + Tungsten-Fabric provider uuid + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + enableHAForCluster + Enables HA cluster-wide + true + 4.11 + + + clusterid + ID of the cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + rebootVirtualMachine + Reboots a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + bootintosetup + Boot into hardware setup menu or not + false + 4.15.0.0 + boolean + + + forced + Force reboot the VM (VM is Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createLoadBalancerRule + Creates a load balancer rule + true + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + true + string + + + name + name of the load balancer rule + true + string + + + privateport + the private port of the private IP address/virtual machine where the network traffic will be load balanced to + true + integer + + + publicport + the public port from where the network traffic will be load balanced from + true + integer + + + account + the account associated with the load balancer. Must be used with the domainId parameter. + false + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed. + false + list + 4.18.0.0 + list + + + description + the description of the load balancer rule + false + string + + + domainid + the domain ID associated with the load balancer + false + uuid + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + networkid + The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case) + false + uuid + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true + false + boolean + + + protocol + The protocol for the LB such as tcp, udp or tcp-proxy. + false + string + + + publicipid + public IP address ID from where the network traffic will be load balanced from + false + uuid + + + zoneid + zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm + false + uuid + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listTungstenFabricLogicalRouter + list Tungsten-Fabric logical router + false + + + keyword + List by keyword + false + string + + + logicalrouteruuid + the uuid of Tungsten-Fabric logical router + false + string + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + importVsphereStoragePolicies + Import vSphere storage policies + false + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the Storage Policy + string + + + description + the description of the Storage Policy + string + + + name + the name of the Storage Policy + string + + + policyid + the identifier of the Storage Policy in vSphere DataCenter + string + + + zoneid + the ID of the Zone + string + + + false + + + listBackupOfferings + Lists backup offerings + false + 4.14.0 + + + id + The backup offering ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + The zone ID + false + uuid + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + addGuestOsMapping + Adds a guest OS name to hypervisor OS name mapping + true + 4.4.0 + + + hypervisor + Hypervisor type. One of : XenServer, KVM, VMWare + true + string + + + hypervisorversion + Hypervisor version to create the mapping for. Use 'default' for default versions + true + string + + + osnameforhypervisor + OS name specific to the hypervisor + true + string + + + osdisplayname + Display Name of Guest OS standard type. Either Display Name or UUID must be passed + false + string + + + ostypeid + UUID of Guest OS type. Either the UUID or Display Name must be passed + false + uuid + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + disableOutOfBandManagementForZone + Disables out-of-band management for a zone + true + 4.9.0 + + + zoneid + the ID of the zone + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + updateNetworkOffering + Updates a network offering. + false + + + availability + the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering + false + string + + + displaytext + the display text of the network offering + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + id + the id of the network offering + false + uuid + + + keepaliveenabled + if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file. + false + boolean + + + maxconnections + maximum number of concurrent connections supported by the network offering + false + integer + + + name + the name of the network offering + false + string + + + sortkey + sort key of the network offering, integer + false + integer + + + state + update state for the network offering + false + string + + + tags + the tags for the network offering. + false + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + createBackup + Create VM backup + true + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listIpv6FirewallRules + Lists all IPv6 firewall rules + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + boolean + + + id + Lists ipv6 firewall rule with the specified ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list ipv6 firewall rules by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + list ipv6 firewall rules by traffic type - ingress or egress + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateVPC + Updates a VPC + true + + + id + the id of the VPC + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displaytext + the display text of the VPC + false + string + + + fordisplay + an optional field, whether to the display the vpc to the end user or not + false + 4.4 + boolean + + + name + the name of the VPC + false + string + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + changeOutOfBandManagementPassword + Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + password + the new host management interface password of maximum length 16, if none is provided a random password would be used + false + string + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + deleteEgressFirewallRule + Deletes an egress firewall rule + true + + + id + the ID of the firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + stopSystemVm + Stops a system VM. + true + + + id + The ID of the system virtual machine + true + uuid + + + forced + Force stop the VM. The caller knows the VM is stopped. + false + boolean + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + listResourceDetails + List resource detail(s) + false + 4.2 + + + resourcetype + list by resource type + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + if set to true, only details marked with display=true, are returned. False by default + false + 4.3 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + key + list by key + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + list by resource id + false + string + + + value + list by key, value. Needs to be passed only along with key + false + 4.4 + string + + + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + false + + + patchSystemVm + Attempts to live patch systemVMs - CPVM, SSVM + true + 4.17.0 + + + forced + If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only + false + boolean + + + id + patches systemVM - CPVM/SSVM with the specified ID + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createNetworkOffering + Creates a network offering. + false + 3.0.0 + + + displaytext + the display text of the network offering + true + string + + + guestiptype + guest type of the network offering: Shared or Isolated + true + string + + + name + the name of the network offering + true + string + + + traffictype + the traffic type for the network offering. Supported type in current release is GUEST only + true + string + + + availability + the availability of network offering. Default value is Optional + false + string + + + conservemode + true if the network offering is IP conserve mode enabled + false + boolean + + + details + Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup + false + map + 4.2.0 + map + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + false + boolean + + + enable + set to true if the offering is to be enabled during creation. Default is false + false + 4.16 + boolean + + + fortungsten + true if network offering is meant to be used for Tungsten-Fabric, false otherwise. + false + boolean + + + forvpc + true if network offering is meant to be used for VPC, false otherwise. + false + boolean + + + internetprotocol + The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6 + false + 4.17.0 + string + + + ispersistent + true if network offering supports persistent networks; defaulted to false if not specified + false + boolean + + + keepaliveenabled + if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file. + false + boolean + + + maxconnections + maximum number of concurrent connections supported by the network offering + false + integer + + + networkrate + data transfer rate in megabits per second allowed + false + integer + + + servicecapabilitylist + desired service capabilities as part of network offering + false + map + map + + + serviceofferingid + the service offering ID used by virtual router provider + false + uuid + + + serviceproviderlist + provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network + false + map + map + + + specifyipranges + true if network offering supports specifying ip ranges; defaulted to false if not specified + false + boolean + + + specifyvlan + true if network offering supports vlans + false + boolean + + + supportedservices + services supported by the network offering + false + list + list + + + tags + the tags for the network offering. + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + dedicateCluster + Dedicate an existing cluster + true + + + clusterid + the ID of the Cluster + true + uuid + + + domainid + the ID of the containing domain + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the cluster + string + + + affinitygroupid + the Dedication Affinity Group ID of the cluster + string + + + clusterid + the ID of the cluster + string + + + clustername + the name of the cluster + string + + + domainid + the domain ID of the cluster + string + + + false + + + createIpForwardingRule + Creates an IP forwarding rule + true + + + ipaddressid + the public IP address ID of the forwarding rule, already associated via associateIp + true + uuid + + + protocol + the protocol for the rule. Valid values are TCP or UDP. + true + string + + + startport + the start port for the rule + true + integer + + + cidrlist + the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use. + false + list + list + + + endport + the end port for the rule + false + integer + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default + false + boolean + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listElastistorInterface + Lists the network Interfaces of elastistor + false + + + controllerid + controller id + false + string + + + + + id + the id of the volume + string + + + compression + compression + string + + + deduplication + deduplication + string + + + graceallowed + graceallowed + string + + + name + the name of the volume + string + + + sync + syncronization + string + + + false + + + listVolumesMetrics + Lists volume metrics + false + 4.9.3 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster id the disk volume belongs to + false + uuid + + + diskofferingid + list volumes by disk offering + false + 4.4 + uuid + + + displayvolume + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hostid + list volumes on specified host + false + uuid + + + id + the ID of the disk volume + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id + false + list + 4.9 + list + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + listsystemvms + list system VMs; only ROOT admin is eligible to pass this parameter + false + 4.18 + boolean + + + name + the name of the disk volume + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod id the disk volume belongs to + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged. + false + string + + + storageid + the ID of the storage pool, available to ROOT admin only + false + 4.3 + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + type + the type of disk volume + false + string + + + virtualmachineid + the ID of the virtual machine + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + diskiopstotal + the total disk iops + long + + + sizegb + disk size in GiB + string + + + false + + + listDetailOptions + Lists all possible details and their options for a resource type such as a VM or a template + false + 4.13 + + + resourcetype + the resource type such as UserVm, Template etc. + true + string + + + resourceid + the UUID of the resource (optional) + false + string + + + + + details + Map of all possible details and their possible list of values + map + + + false + + + listSslCerts + Lists SSL certificates + false + + + accountid + Account ID + false + uuid + + + certid + ID of SSL certificate + false + uuid + + + lbruleid + Load balancer rule ID + false + uuid + + + projectid + Project that owns the SSL certificate + false + uuid + + + + + id + SSL certificate ID + string + + + account + account for the certificate + string + + + certchain + certificate chain + string + + + certificate + certificate + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + fingerprint + certificate fingerprint + string + + + loadbalancerrulelist + List of loabalancers this certificate is bound to + list + + + name + name + string + + + project + the project name of the certificate + string + + + projectid + the project id of the certificate + string + + + false + + + quotaStatement + Create a quota statement + false + 4.7.0 + + + account + Optional, Account Id for which statement needs to be generated + true + string + + + domainid + Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain. + true + uuid + + + enddate + End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + true + date + + + startdate + Start date range quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + true + date + + + accountid + List usage records for the specified account + false + uuid + + + type + List quota usage records for the specified usage type + false + integer + + + + + account + account name + string + + + accountid + account id + long + + + domain + domain id + long + + + name + usage type name + string + + + quota + quota consumed + bigdecimal + + + type + usage type + int + + + unit + usage unit + string + + + false + + + updateLBStickinessPolicy + Updates load balancer stickiness policy + true + 4.4 + + + id + id of lb stickiness policy + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + updateVmNicIp + Update the default Ip of a VM Nic + true + + + nicid + the ID of the nic to which you want to assign private IP + true + uuid + + + ipaddress + Secondary IP Address + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listPrivateGateways + List private gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list private gateway by id + false + uuid + + + ipaddress + list gateways by ip address + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + list gateways by state + false + string + + + vlan + list gateways by vlan + false + string + + + vpcid + list gateways by vpc + false + uuid + + + + + id + the id of the private gateway + string + + + account + the account associated with the private gateway + string + + + aclid + ACL Id set for private gateway + string + + + aclname + ACL name set for private gateway + string + + + domain + the domain associated with the private gateway + string + + + domainid + the ID of the domain associated with the private gateway + string + + + gateway + the gateway + string + + + ipaddress + the private gateway's ip address + string + + + netmask + the private gateway's netmask + string + + + physicalnetworkid + the physical network id + string + + + project + the project name of the private gateway + string + + + projectid + the project id of the private gateway + string + + + sourcenatsupported + Source Nat enable status + boolean + + + state + State of the gateway, can be Creating, Ready, Deleting + string + + + vlan + the network implementation uri for the private gateway + string + + + vpcid + VPC id the private gateway belongs to + string + + + vpcname + VPC name the private gateway belongs to + 4.13.2 + string + + + zoneid + zone id of the private gateway + string + + + zonename + the name of the zone the private gateway belongs to + string + + + false + + + startInternalLoadBalancerVM + Starts an existing internal lb vm. + true + + + id + the ID of the internal lb vm + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listPods + Lists all Pods. + false + + + allocationstate + list pods by allocation state + false + string + + + id + list Pods by ID + false + uuid + + + keyword + List by keyword + false + string + + + name + list Pods by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the pods + false + boolean + + + zoneid + list Pods by Zone ID + false + uuid + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + deleteTungstenFabricAddressGroup + delete Tungsten-Fabric address group + true + + + addressgroupuuid + the uuid of Tungsten-Fabric address group + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateDiskOffering + Updates a disk offering. + false + + + id + ID of the disk offering + true + uuid + + + bytesreadrate + bytes read rate of the disk offering + false + 4.15 + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + 4.15 + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + byteswriterate + bytes write rate of the disk offering + false + 4.15 + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + 4.15 + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + cachemode + the cache mode to use for this disk offering + false + 4.15 + string + + + displayoffering + an optional field, whether to display the offering to the end user or not. + false + boolean + + + displaytext + updates alternate display text of the disk offering with this value + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + 4.13 + string + + + iopsreadrate + io requests read rate of the disk offering + false + 4.15 + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + 4.15 + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + iopswriterate + io requests write rate of the disk offering + false + 4.15 + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + 4.15 + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + name + updates name of the disk offering with this value + false + string + + + sortkey + sort key of the disk offering, integer + false + integer + + + tags + comma-separated list of tags for the disk offering, tags should match with existing storage pool tags + false + 4.15 + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + storagetype + the storage type for this disk offering + string + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + quotaTariffList + Lists all quota tariff plans + false + 4.7.0 + + + enddate + The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2021-11-03. + false + 4.18.0.0 + date + + + keyword + List by keyword + false + string + + + listall + False will list only not removed quota tariffs. If set to True, we will list all, including the removed ones. The default is false. + false + 4.18.0.0 + boolean + + + name + The name of the quota tariff. + false + 4.18.0.0 + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + The start date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + usagetype + Usage type of the resource + false + integer + + + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + uuid + uuid + string + + + false + + + stopKubernetesCluster + Stops a running Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSnapshots + Lists all available snapshots for the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + lists snapshot by snapshot ID + false + uuid + + + ids + the IDs of the snapshots, mutually exclusive with id + false + list + 4.9 + list + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY. + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + lists snapshot by snapshot name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + snapshottype + valid values are MANUAL or RECURRING. + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + volumeid + the ID of the disk volume + false + uuid + + + zoneid + list snapshots by zone id + false + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteTungstenFabricLogicalRouter + delete Tungsten-Fabric logical router + true + + + logicalrouteruuid + the uuid of Tungsten-Fabric logical router + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addAccountToProject + Adds account to a project + true + 3.0.0 + + + projectid + ID of the project to add the account to + true + uuid + + + account + name of the account to be added to the project + false + string + + + email + email to which invitation to the project is going to be sent + false + string + + + projectroleid + ID of the project role + false + uuid + + + roletype + Project role type to be assigned to the user - Admin/Regular; default: Regular + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listKubernetesClusters + Lists Kubernetes clusters + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the Kubernetes cluster + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned) + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + state of the Kubernetes cluster + false + string + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + resetVpnConnection + Reset site to site vpn connection + true + + + id + id of vpn connection + true + uuid + + + account + an optional account for connection. Must be used with domainId. + false + string + + + domainid + an optional domainId for connection. If the account parameter is used, domainId must also be used. + false + uuid + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + deleteSSHKeyPair + Deletes a keypair by name + false + + + name + Name of the keypair + true + string + + + account + the account associated with the keypair. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the keypair + false + uuid + + + projectid + the project associated with keypair + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + searchLdap + Searches LDAP based on the username attribute + false + 4.2.0 + + + query + query to search using + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + createAutoScaleVmGroup + Creates and automatically starts a virtual machine based on a service offering, disk offering, and template. + true + + + lbruleid + the ID of the load balancer rule + true + uuid + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + true + integer + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + true + integer + + + scaledownpolicyids + list of scaledown autoscale policies + true + list + list + + + scaleuppolicyids + list of scaleup autoscale policies + true + list + list + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + true + uuid + + + fordisplay + an optional field, whether to the display the group to the end user or not + false + 4.4 + boolean + + + interval + the frequency in which the performance counters to be collected + false + integer + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + deleteLoadBalancerRule + Deletes a load balancer rule. + true + + + id + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addBaremetalPxePingServer + add a baremetal ping pxe server + true + + + password + Credentials to reach external pxe device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + pingdir + Root directory on PING storage server + true + string + + + pingstorageserverip + PING storage server ip + true + string + + + pxeservertype + type of pxe device + true + string + + + tftpdir + Tftp root directory of PXE server + true + string + + + url + URL of the external pxe device + true + string + + + username + Credentials to reach external pxe device + true + string + + + pingcifspassword + Password of PING storage server + false + string + + + pingcifsusername + Username of PING storage server + false + string + + + podid + Pod Id + false + uuid + + + + + pingdir + Root directory on PING storage server + string + + + pingstorageserverip + PING storage server ip + string + + + tftpdir + Tftp root directory of PXE server + string + + + false + + + createTungstenFabricLogicalRouter + create Tungsten-Fabric logical router + true + + + name + Tungsten-Fabric logical router name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createTungstenFabricFirewallRule + create Tungsten-Fabric firewall + true + + + action + Tungsten-Fabric firewall rule action + true + string + + + direction + Tungsten-Fabric firewall rule direction + true + string + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + true + string + + + name + Tungsten-Fabric firewall rule name + true + string + + + sequence + the sequence of Tungsten-Fabric firewall rule + true + integer + + + servicegroupuuid + Tungsten-Fabric firewall rule service group uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + destaddressgroupuuid + Tungsten-Fabric firewall rule destination address group uuid + false + string + + + destnetworkuuid + the uuid of Tungsten-Fabric destination network + false + string + + + desttaguuid + Tungsten-Fabric firewall rule destination tag uuid + false + string + + + srcaddressgroupuuid + Tungsten-Fabric firewall rule source address group uuid + false + string + + + srcnetworkuuid + the uuid of Tungsten-Fabric source network + false + string + + + srctaguuid + Tungsten-Fabric firewall rule source tag uuid + false + string + + + tagtypeuuid + Tungsten-Fabric firewall rule tag type uuid + false + string + + + + + action + Tungsten-Fabric firewall rule action + string + + + destaddressgroup + Tungsten-Fabric firewall rule destination address group + string + + + destnetwork + Tungsten-Fabric firewall rule destination network + string + + + desttag + Tungsten-Fabric firewall rule destination tag + string + + + direction + Tungsten-Fabric firewall rule direction + string + + + name + Tungsten-Fabric firewall rule name + string + + + servicegroup + Tungsten-Fabric firewall rule service group + string + + + srcaddressgroup + Tungsten-Fabric firewall rule source address group + string + + + srcnetwork + Tungsten-Fabric firewall rule source network + string + + + srctag + Tungsten-Fabric firewall rule source tag + string + + + tagtype + Tungsten-Fabric firewall rule tag type + string + + + uuid + Tungsten-Fabric firewall rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listPortableIpRanges + list portable IP ranges + false + + + id + Id of the portable ip range + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + regionid + Id of a Region + false + integer + + + + + id + portable IP range ID + string + + + endip + the end ip of the portable IP range + string + + + gateway + the gateway of the VLAN IP range + string + + + netmask + the netmask of the VLAN IP range + string + + + regionid + Region Id in which portable ip range is provisioned + integer + + + startip + the start ip of the portable IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + portableipaddress(*) + List of portable IP and association with zone/network/vpc details that are part of GSLB rule + + + accountid + the account ID the portable IP address is associated with + string + + + allocated + date the portal IP address was acquired + date + + + domainid + the domain ID the portable IP address is associated with + string + + + ipaddress + public IP address + string + + + networkid + the ID of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + regionid + Region Id in which global load balancer is created + integer + + + state + State of the ip address. Can be: Allocatin, Allocated and Releasing + string + + + vpcid + VPC the ip belongs to + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + list + + + false + + + getVirtualMachineUserData + Returns user data associated with the VM + false + 4.4 + + + virtualmachineid + The ID of the virtual machine + true + uuid + + + + + userdata + Base 64 encoded VM user data + string + + + virtualmachineid + the ID of the virtual machine + string + + + false + + + createNetworkPermissions + Updates network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + accountids + a comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + accounts + a comma delimited list of accounts within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + projectids + a comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listConfigurations + Lists all configurations. + false + + + accountid + the ID of the Account to update the parameter value for corresponding account + false + uuid + + + category + lists configurations by category + false + string + + + clusterid + the ID of the Cluster to update the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to update the parameter value for corresponding domain + false + uuid + + + group + lists configuration by group name (primarily used for UI) + false + 4.18.0 + string + + + imagestoreuuid + the ID of the Image Store to update the parameter value for corresponding image store + false + uuid + + + keyword + List by keyword + false + string + + + name + lists configuration by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parent + lists configuration by parent name (primarily used for UI) + false + 4.18.0 + string + + + storageid + the ID of the Storage pool to update the parameter value for corresponding storage pool + false + uuid + + + subgroup + lists configuration by subgroup name (primarily used for UI) + false + 4.18.0 + string + + + zoneid + the ID of the Zone to update the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + quotaTariffUpdate + Update the tariff plan for a resource + false + 4.7.0 + + + name + Quota tariff's name + true + 4.18.0.0 + string + + + activationrule + Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule. + false + 4.18.0.0 + string + + + description + Quota tariff's description. Inform empty to remove the description. + false + 4.18.0.0 + string + + + enddate + The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2009-06-03. + false + 4.18.0.0 + date + + + startdate + DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + usagetype + DEPRECATED. Integer value for the usage type of the resource + false + integer + + + value + The quota tariff value of the resource as per the default unit. + false + double + + + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + uuid + uuid + string + + + false + + + addIpToNic + Assigns secondary IP to NIC + true + + + nicid + the ID of the nic to which you want to assign private IP + true + uuid + + + ipaddress + Secondary IP Address + false + string + + + + + id + the ID of the secondary private IP addr + string + + + ipaddress + Secondary IP address + string + + + networkid + the ID of the network + string + + + nicid + the ID of the nic + string + + + secondaryip + the list of Secondary ipv4 addr of nic + list + + + virtualmachineid + the ID of the vm + string + + + false + + + disableStaticNat + Disables static rule for given IP address + true + + + ipaddressid + the public IP address ID for which static NAT feature is being disabled + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + scaleKubernetesCluster + Scales a created, running or stopped Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + false + boolean + + + maxsize + Maximum number of worker nodes in the cluster + false + long + + + minsize + Minimum number of worker nodes in the cluster + false + long + + + nodeids + the IDs of the nodes to be removed + false + list + list + + + serviceofferingid + the ID of the service offering for the virtual machines in the cluster. + false + uuid + + + size + number of Kubernetes cluster nodes + false + long + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + stopNetScalerVpx + Stops a NetScalervm. + true + + + id + the ID of the NetScaler vm + true + uuid + + + forced + Force stop the VM. The caller knows the VM is stopped. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + deleteUcsManager + Delete a Ucs manager + false + + + ucsmanagerid + ucs manager id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteHost + Deletes a host. + false + + + id + the host ID + true + uuid + + + forced + Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped + false + boolean + + + forcedestroylocalstorage + Force destroy local storage on this host. All VMs created on this local storage will be destroyed + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteResourceIcon + deletes the resource icon from the specified resource(s) + false + 4.16.0.0 + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteInstanceGroup + Deletes a vm group + false + + + id + the ID of the instance group + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listCapabilities + Lists capabilities + false + + + + allowusercreateprojects + true if regular user is allowed to create projects + boolean + + + allowuserexpungerecovervm + true if the user can recover and expunge virtualmachines, false otherwise + 4.6.0 + boolean + + + allowuserexpungerecovervolume + true if the user can recover and expunge volumes, false otherwise + 4.14.0 + boolean + + + allowuserviewalldomainaccounts + true if users can see all accounts within the same domain, false otherwise + boolean + + + allowuserviewdestroyedvm + true if the user is allowed to view destroyed virtualmachines, false otherwise + 4.6.0 + boolean + + + apilimitinterval + time interval (in seconds) to reset api count + integer + + + apilimitmax + Max allowed number of api requests within the specified interval + integer + + + cloudstackversion + version of the cloud stack + string + + + customdiskofferingmaxsize + maximum size that can be specified when create disk from disk offering with custom size + long + + + customdiskofferingminsize + minimum size that can be specified when create disk from disk offering with custom size + long + + + defaultuipagesize + default page size in the UI for various views, value set in the configurations + 4.15.2 + long + + + dynamicrolesenabled + true if dynamic role-based api checker is enabled, false otherwise + boolean + + + instancesdisksstatsretentionenabled + true if stats are retained for instance disks otherwise false + 4.18.0 + boolean + + + instancesdisksstatsretentiontime + the retention time for Instances disks stats + 4.18.0 + integer + + + instancesstatsretentiontime + the retention time for Instances stats + 4.18.0 + integer + + + instancesstatsuseronly + true if stats are collected only for user instances, false if system instance stats are also collected + 4.18.0 + boolean + + + kubernetesclusterexperimentalfeaturesenabled + true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise + boolean + + + kubernetesserviceenabled + true if Kubernetes Service plugin is enabled, false otherwise + boolean + + + kvmsnapshotenabled + true if snapshot is supported for KVM host, false otherwise + boolean + + + projectinviterequired + If invitation confirmation is required when add account to project + boolean + + + regionsecondaryenabled + true if region wide secondary is enabled, false otherwise + boolean + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + supportELB + true if region supports elastic load balancer on basic zones + string + + + userpublictemplateenabled + true if user and domain admins can set templates to be shared, false otherwise + boolean + + + false + + + releaseDedicatedZone + Release dedication of zone + true + + + zoneid + the ID of the Zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateTrafficType + Updates traffic type of a physical network + true + 3.0.0 + + + id + traffic type id + true + uuid + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a Hyperv host + false + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + false + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + false + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + false + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + false + string + + + + + id + id of the network provider + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a HyperV host + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + string + + + physicalnetworkid + the physical network this belongs to + string + + + traffictype + the trafficType to be added to the physical network + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + string + + + false + + + listConditions + List Conditions for VM auto scaling + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + counterid + Counter-id of the condition. + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + ID of the Condition. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + policyid + the ID of the policy + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the id of the Condition + string + + + account + the owner of the Condition. + string + + + counter + Details of the Counter. + counterresponse + + + counterid + the Id of the Counter. + string + + + countername + the Name of the Counter. + string + + + domain + the domain name of the owner. + string + + + domainid + the domain id of the Condition owner + string + + + project + the project name of the Condition + string + + + projectid + the project id of the Condition. + string + + + relationaloperator + Relational Operator to be used with threshold. + string + + + threshold + Threshold Value for the counter. + long + + + zoneid + zone id of counter + string + + + false + + + updateNetworkServiceProvider + Updates a network serviceProvider of a physical network + true + 3.0.0 + + + id + network service provider id + true + uuid + + + servicelist + the list of services to be enabled for this physical network service provider + false + list + list + + + state + Enabled/Disabled/Shutdown the physical network service provider + false + string + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + listManagementServersMetrics + Lists Management Server metrics + false + 4.17.0 + + + id + the id of the management server + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the management server + false + string + + + page + false + integer + + + pagesize + false + integer + + + system + include system level stats + false + boolean + + + + + agentcount + the number of agents this Management Server is responsible for + integer + + + availableprocessors + the number of processors available to the JVM + integer + + + collectiontime + the time these statistics were collected + date + + + cpuload + the current cpu load + string + + + dbislocal + the system is running against a local database + boolean + + + heapmemorytotal + the amount of memory allocated to this Management Server + long + + + heapmemoryused + the amount of memory used by this Management Server + long + + + loginfo + the log files and their usage on disk + string + + + sessions + the number of client sessions active on this Management Server + long + + + systemcycleusage + the system load for user, and system processes and the system idle cycles + long[] + + + systemloadaverages + the load averages for 1 5 and 15 minutes + double[] + + + systemmemoryfree + Free system memory + string + + + systemmemorytotal + Total system memory + string + + + systemmemoryused + Amount of memory used + string + + + systemmemoryvirtualsize + Virtual size of the fully loaded process + string + + + systemtotalcpucycles + the total system cpu capacity + double + + + threadsblockedcount + The number of blocked threads + integer + + + threadsdaemoncount + The number of daemon threads + integer + + + threadsrunnablecount + The number of runnable threads + integer + + + threadsteminatedcount + The number of terminated threads + integer + + + threadstotalcount + The number of threads + integer + + + threadswaitingcount + The number of waiting threads + integer + + + usageislocal + the system has a usage server running locally + boolean + + + false + + + removeFromLoadBalancerRule + Removes a virtual machine or a list of virtual machines from a load balancer rule. + true + + + id + The ID of the load balancer rule + true + uuid + + + virtualmachineids + the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3) + false + list + list + + + vmidipmap + VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75 + false + map + 4.4 + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listInstanceGroups + Lists vm groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list instance groups by ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list instance groups by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + migrateSecondaryStorageData + migrates data objects from one secondary storage to destination image store(s) + true + 4.15.0 + + + destpools + id(s) of the destination secondary storage pool(s) to which the templates are to be migrated + true + list + list + + + srcpool + id of the image store from where the data is to be migrated + true + uuid + + + migrationtype + Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete + false + string + + + + + message + Response message from migration of secondary storage data objects + string + + + migrationtype + Type of migration requested for + string + + + success + true if operation is executed successfully + boolean + + + false + + + createStaticRoute + Creates a static route + true + + + cidr + static route cidr + true + string + + + gatewayid + the gateway id we are creating static route for + true + uuid + + + + + id + the ID of static route + string + + + account + the account associated with the static route + string + + + cidr + static route CIDR + string + + + domain + the domain associated with the static route + string + + + domainid + the ID of the domain associated with the static route + string + + + gatewayid + VPC gateway the route is created for + string + + + project + the project name of the static route + string + + + projectid + the project id of the static route + string + + + state + the state of the static route + string + + + vpcid + VPC the static route belongs to + string + + + tags(*) + the list of resource tags associated with static route + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + destroyVolume + Destroys a Volume. + true + 4.14.0 + + + id + The ID of the volume + true + uuid + + + expunge + If true is passed, the volume is expunged immediately. False by default. + false + 4.6.0 + boolean + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addTrafficType + Adds traffic type to a physical network + true + 3.0.0 + + + physicalnetworkid + the Physical Network ID + true + uuid + + + traffictype + the trafficType to be added to the physical network + true + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a Hyperv host + false + string + + + isolationmethod + Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'. + false + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + false + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + false + string + + + vlan + The VLAN id to be used for Management traffic by VMware host + false + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + false + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + false + string + + + + + id + id of the network provider + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a HyperV host + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + string + + + physicalnetworkid + the physical network this belongs to + string + + + traffictype + the trafficType to be added to the physical network + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + string + + + false + + + deletePrivateGateway + Deletes a Private gateway + true + + + id + the ID of the private gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listLoadBalancerRuleInstances + List all virtual machine instances that are assigned to a load balancer rule. + false + + + id + the ID of the load balancer rule + true + uuid + + + applied + true if listing all virtual machines currently applied to the load balancer rule; default is true + false + boolean + + + keyword + List by keyword + false + string + + + lbvmips + true if load balancer rule VM IP information to be included; default is false + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + + + lbvmipaddresses + IP addresses of the vm set of lb rule + list + + + loadbalancerruleinstance + the user vm set for lb rule + uservmresponse + + + false + + + deleteCondition + Removes a condition for VM auto scaling + true + + + id + the ID of the condition. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateDomain + Updates a domain with a new name + false + + + id + ID of domain to update + true + uuid + + + name + updates domain with this name + false + string + + + networkdomain + Network domain for the domain's networks; empty string will update domainName with NULL value + false + string + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + updatePhysicalNetwork + Updates a physical network + true + 3.0.0 + + + id + physical network id + true + uuid + + + networkspeed + the speed for the physical network[1G/10G] + false + string + + + state + Enabled/Disabled + false + string + + + tags + Tag the physical network + false + list + list + + + vlan + the VLAN for the physical network + false + string + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + disableAutoScaleVmGroup + Disables an AutoScale Vm Group + true + + + id + the ID of the autoscale group + true + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + createTungstenFabricManagementNetwork + create Tungsten-Fabric management network + false + + + podid + the ID of pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createSnapshotPolicy + Creates a snapshot policy for the account. + false + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + maxsnaps + maximum number of snapshots to retain + true + integer + + + schedule + time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + true + string + + + volumeid + the ID of the disk volume + true + uuid + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + tags + Map of tags (key/value pairs) + false + map + map + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + false + + + disableHAForZone + Disables HA for a zone + true + 4.11 + + + zoneid + ID of the zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricFirewallRule + list Tungsten-Fabric firewall rule + false + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + false + string + + + firewallruleuuid + the uuid of Tungsten-Fabric firewall rule + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + action + Tungsten-Fabric firewall rule action + string + + + destaddressgroup + Tungsten-Fabric firewall rule destination address group + string + + + destnetwork + Tungsten-Fabric firewall rule destination network + string + + + desttag + Tungsten-Fabric firewall rule destination tag + string + + + direction + Tungsten-Fabric firewall rule direction + string + + + name + Tungsten-Fabric firewall rule name + string + + + servicegroup + Tungsten-Fabric firewall rule service group + string + + + srcaddressgroup + Tungsten-Fabric firewall rule source address group + string + + + srcnetwork + Tungsten-Fabric firewall rule source network + string + + + srctag + Tungsten-Fabric firewall rule source tag + string + + + tagtype + Tungsten-Fabric firewall rule tag type + string + + + uuid + Tungsten-Fabric firewall rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listSystemVms + List system virtual machines. + false + + + hostid + the host ID of the system VM + false + uuid + + + id + the ID of the system VM + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the system VM + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the system VM + false + uuid + + + state + the state of the system VM + false + string + + + storageid + the storage ID where vm's volumes belong to + false + 3.0.1 + uuid + + + systemvmtype + the system VM type. Possible types are "consoleproxy" and "secondarystoragevm". + false + string + + + zoneid + the Zone ID of the system VM + false + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + createRolePermission + Adds an API permission to a role + false + 4.9.0 + + + permission + The rule permission, allow or deny. Default: deny. + true + string + + + roleid + ID of the role + true + uuid + + + rule + The API name or wildcard rule such as list* + true + string + + + description + The description of the role permission + false + string + + + + + id + the ID of the role permission + string + + + roleid + the ID of the role to which the role permission belongs + string + + + rolename + the name of the role to which the role permission belongs + string + + + false + + + createProject + Creates a project + true + 3.0.0 + + + displaytext + display text of the project + true + string + + + name + name of the project + true + string + + + account + account who will be Admin for the project + false + string + + + accountid + ID of the account owning a project + false + uuid + + + domainid + domain ID of the account owning a project + false + uuid + + + userid + user ID of the account to be assigned as owner of the project i.e., Project Admin + false + 4.15.0 + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + assignCertToLoadBalancer + Assigns a certificate to a load balancer rule + true + + + certid + the ID of the certificate + true + uuid + + + lbruleid + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addCiscoVnmcResource + Adds a Cisco Vnmc Controller + false + + + hostname + Hostname or ip address of the Cisco VNMC Controller. + true + string + + + password + Credentials to access the Cisco VNMC Controller API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Credentials to access the Cisco VNMC Controller API + true + string + + + + false + + + replaceNetworkACLList + Replaces ACL associated with a network or private gateway + true + + + aclid + the ID of the network ACL + true + uuid + + + gatewayid + the ID of the private gateway + false + uuid + + + networkid + the ID of the network + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + detachVolume + Detaches a disk volume from a virtual machine. + true + + + deviceid + the device ID on the virtual machine where volume is detached from + false + long + + + id + the ID of the disk volume + false + uuid + + + virtualmachineid + the ID of the virtual machine where the volume is detached from + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTungstenFabricAddressGroup + list Tungsten-Fabric address group + false + + + addressgroupuuid + the uuid of Tungsten-Fabric address group + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + ipprefix + Tungsten-Fabric address group ip prefix + string + + + ipprefixlen + Tungsten-Fabric address group ip prefix length + int + + + name + Tungsten-Fabric address group name + string + + + uuid + Tungsten-Fabric address group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + enableOutOfBandManagementForZone + Enables out-of-band management for a zone + true + 4.9.0 + + + zoneid + the ID of the zone + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listLdapUsers + Lists LDAP Users according to the specifications from the user request. + false + 4.2.0 + + + domainid + linked domain + false + uuid + + + keyword + List by keyword + false + string + + + listtype + Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter + false + string + + + page + false + integer + + + pagesize + false + integer + + + userfilter + Determines what type of filter is applied on the list of users returned from LDAP. + valid values are + 'NoFilter' no filtering is done, + 'LocalDomain' users already in the current or requested domain will be filtered out of the result list, + 'AnyDomain' users that already exist anywhere in cloudstack will be filtered out, and + 'PotentialImport' all users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource + false + 4.13 + string + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + markDefaultZoneForAccount + Marks a default zone for this account + true + 4.0 + + + account + Name of the account that is to be marked. + true + string + + + domainid + Marks the account that belongs to the specified domain. + true + uuid + + + zoneid + The Zone ID with which the account is to be marked. + true + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + revokeCertificate + Revokes certificate using configured CA plugin + true + 4.11.0 + + + serial + The certificate serial number, as a hex value + true + string + + + cn + The certificate CN + false + string + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + changeServiceForSystemVm + Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect. + false + + + id + The ID of the system vm + true + uuid + + + serviceofferingid + the service offering ID to apply to the system vm + true + uuid + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + updateSiocInfo + Update SIOC info + false + 4.11.0 + + + iopsnotifythreshold + Notify if IOPS above this value + true + integer + + + limitiopspergb + Limit IOPS per GB + true + integer + + + sharespergb + Shares per GB + true + integer + + + storageid + Storage Pool ID + true + uuid + + + zoneid + Zone ID + true + uuid + + + + + msg + The return message from the operation ('Success' if successful) + string + + + false + + + cloudianSsoLogin + Generates single-sign-on login url for logged-in CloudStack user to access the Cloudian Management Console + false + 4.11.0 + + + + url + the sso redirect url + string + + + false + + + listIpForwardingRules + List the IP forwarding rules + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + list the rule belonging to this public IP address + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + virtualmachineid + Lists all rules applied to the specified VM. + false + uuid + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createSnapshot + Creates an instant snapshot of a volume. + true + + + volumeid + The ID of the disk volume + true + uuid + + + account + The account of the snapshot. The account parameter must be used with the domainId parameter. + false + string + + + asyncbackup + asynchronous backup if true + false + boolean + + + domainid + The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. + false + uuid + + + locationtype + Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'. + false + string + + + name + the name of the snapshot + false + string + + + policyid + policy id of the snapshot, if this is null, then use MANUAL_POLICY. + false + uuid + + + quiescevm + quiesce vm if true + false + boolean + + + tags + Map of tags (key/value pairs) + false + map + map + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteVMSnapshot + Deletes a vmsnapshot. + true + 4.2.0 + + + vmsnapshotid + The ID of the VM snapshot + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listStoragePoolsMetrics + Lists storage pool metrics + false + 4.9.3 + + + clusterid + list storage pools belongig to the specific cluster + false + uuid + + + id + the ID of the storage pool + false + uuid + + + ipaddress + the IP address for the storage pool + false + string + + + keyword + List by keyword + false + string + + + name + the name of the storage pool + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the storage pool path + false + string + + + podid + the Pod ID for the storage pool + false + uuid + + + scope + the ID of the storage pool + false + string + + + zoneid + the Zone ID for the storage pool + false + uuid + + + + + disksizeallocatedgb + disk size allocated in GiB + string + + + disksizetotalgb + disk size in GiB + string + + + disksizeunallocatedgb + disk size unallocated in GiB + string + + + disksizeusedgb + disk size used in GiB + string + + + storageallocateddisablethreshold + storage allocated disable threshold exceeded + boolean + + + storageallocatedthreshold + storage allocated notification threshold exceeded + boolean + + + storageusagedisablethreshold + storage usage disable threshold exceeded + boolean + + + storageusagethreshold + storage usage notification threshold exceeded + boolean + + + false + + + unmanageVirtualMachine + Unmanage a guest virtual machine. + true + 4.15.0 + + + id + The ID of the virtual machine to unmanage + true + uuid + + + + + details + details of the unmanage VM operation + string + + + success + result of the unmanage VM operation + boolean + + + false + + + listNics + list the vm nics IP to NIC + false + + + virtualmachineid + the ID of the vm + true + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + keyword + List by keyword + false + string + + + networkid + list nic of the specific vm's network + false + uuid + + + nicid + the ID of the nic to to list IPs + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + false + + + rebootRouter + Starts a router. + true + + + id + the ID of the router + true + uuid + + + forced + Force reboot the router (Router is force Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + createSSHKeyPair + Create a new keypair and returns the private key + false + + + name + Name of the keypair + true + string + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the ssh key. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the ssh key + false + uuid + + + + + privatekey + Private key + string + + + false + + + deleteBackupOffering + Deletes a backup offering + false + 4.14.0 + + + id + ID of the backup offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createSnapshotFromVMSnapshot + Creates an instant snapshot of a volume from existing vm snapshot. + true + 4.10.0 + + + vmsnapshotid + The ID of the VM snapshot + true + uuid + + + volumeid + The ID of the disk volume + true + uuid + + + name + the name of the snapshot + false + string + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTungstenFabricServiceGroup + list Tungsten-Fabric service group + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + servicegroupuuid + the uuid of Tungsten-Fabric service group + false + string + + + zoneid + the ID of zone + false + uuid + + + + + endport + Tungsten-Fabric service group end port + int + + + name + Tungsten-Fabric service group name + string + + + protocol + Tungsten-Fabric service group protocol + string + + + startport + Tungsten-Fabric service group start port + int + + + uuid + Tungsten-Fabric service group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + authorizeSecurityGroupEgress + Authorizes a particular egress rule for this security group + true + 3.0.0 + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + cidrlist + the cidr list associated. Multiple entries must be separated by a single comma character (,). + false + list + list + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + endport + end port for this egress rule + false + integer + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + projectid + an optional project of the security group + false + uuid + + + protocol + TCP is default. UDP is the other supported protocol + false + string + + + securitygroupid + The ID of the security group. Mutually exclusive with securityGroupName parameter + false + uuid + + + securitygroupname + The name of the security group. Mutually exclusive with securityGroupId parameter + false + string + + + startport + start port for this egress rule + false + integer + + + usersecuritygrouplist + user to security group mapping + false + map + map + + + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listStoragePools + Lists storage pools. + false + + + clusterid + list storage pools belongig to the specific cluster + false + uuid + + + id + the ID of the storage pool + false + uuid + + + ipaddress + the IP address for the storage pool + false + string + + + keyword + List by keyword + false + string + + + name + the name of the storage pool + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the storage pool path + false + string + + + podid + the Pod ID for the storage pool + false + uuid + + + scope + the ID of the storage pool + false + string + + + zoneid + the Zone ID for the storage pool + false + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + name + the name of the storage pool + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + enableCiscoNexusVSM + Enable a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be enabled + true + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + updateHypervisorCapabilities + Updates a hypervisor capabilities. + false + 3.0.0 + + + id + ID of the hypervisor capability + false + uuid + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached to a VM for this hypervisor. + false + 4.16.0 + integer + + + maxguestslimit + the max number of Guest VMs per host for this hypervisor. + false + long + + + maxhostspercluster + the maximum number of the hypervisor hosts per cluster + false + 4.16.0 + integer + + + securitygroupenabled + set true to enable security group for this hypervisor. + false + boolean + + + storagemotionenabled + set true to enable storage motion support for this hypervisor + false + 4.16.0 + boolean + + + vmsnapshotenabled + set true to enable VM snapshots for this hypervisor + false + 4.16.0 + boolean + + + + + id + the ID of the hypervisor capabilities row + string + + + hypervisor + the hypervisor type + hypervisortype + + + hypervisorversion + the hypervisor version + string + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached for this hypervisor + integer + + + maxguestslimit + the maximum number of guest vms recommended for this hypervisor + long + + + maxhostspercluster + the maximum number of Hosts per cluster for this hypervisor + integer + + + securitygroupenabled + true if security group is supported + boolean + + + storagemotionenabled + true if storage motion is supported + boolean + + + vmsnapshotenabled + true if VM snapshots are enabled for this hypervisor + boolean + + + false + + + findHostsForMigration + Find hosts suitable for migrating a virtual machine. + false + + + virtualmachineid + find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the host + string + + + averageload + the cpu average load on the host + long + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpunumber + the CPU number of the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + hypervisortype + + + hypervisorversion + the hypervisor version + string + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + long + + + memoryallocated + the amount of the host's memory currently allocated + string + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + requiresStorageMotion + true if migrating a vm to this host requires storage motion, false otherwise + boolean + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + false + + + isAccountAllowedToCreateOfferingsWithTags + Return true if the specified account is allowed to create offerings with tags. + false + + + id + Account UUID + false + uuid + + + + + isallowed + is domain admin allowed to create offerings with tags + boolean + + + false + + + addNicToVirtualMachine + Adds VM to specified network by creating a NIC + true + + + networkid + Network ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + dhcpoptions + DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com + false + map + map + + + ipaddress + IP Address for the new network + false + string + + + macaddress + Mac Address for the new network + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + dedicateGuestVlanRange + Dedicates a guest vlan range to an account + false + + + physicalnetworkid + physical network ID of the vlan + true + uuid + + + vlanrange + guest vlan range to be dedicated + true + string + + + account + account who will own the VLAN + false + string + + + domainid + domain ID of the account owning a VLAN + false + uuid + + + projectid + project who will own the VLAN + false + uuid + + + + + id + the ID of the guest VLAN range + string + + + account + the account of the guest VLAN range + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + guestvlanrange + the guest VLAN range + string + + + physicalnetworkid + the physical network of the guest vlan range + long + + + project + the project name of the guest vlan range + string + + + projectid + the project id of the guest vlan range + string + + + zoneid + the zone of the guest vlan range + long + + + false + + + getSPMetadata + Returns SAML2 CloudStack Service Provider MetaData + false + + + + metadata + The Metadata XML + string + + + false + + + listStaticRoutes + Lists all static routes + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + gatewayid + list static routes by gateway id + false + uuid + + + id + list static route by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + list static routes by state + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vpcid + list static routes by vpc id + false + uuid + + + + + id + the ID of static route + string + + + account + the account associated with the static route + string + + + cidr + static route CIDR + string + + + domain + the domain associated with the static route + string + + + domainid + the ID of the domain associated with the static route + string + + + gatewayid + VPC gateway the route is created for + string + + + project + the project name of the static route + string + + + projectid + the project id of the static route + string + + + state + the state of the static route + string + + + vpcid + VPC the static route belongs to + string + + + tags(*) + the list of resource tags associated with static route + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listPublicIpAddresses + Lists all public ip addresses + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + allocatedonly + limits search results to allocated public IP addresses + false + boolean + + + associatednetworkid + lists all public IP addresses associated to the network specified + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + forloadbalancing + list only IPs used for load balancing + false + boolean + + + forvirtualnetwork + the virtual network for the IP address + false + boolean + + + id + lists IP address by ID + false + uuid + + + ipaddress + lists the specified IP address + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issourcenat + list only source NAT IP addresses + false + boolean + + + isstaticnat + list only static NAT IP addresses + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + lists all public IP addresses by source network ID + false + 4.13.0 + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + lists all public IP addresses by physical network ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + lists all public IP addresses by state + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vlanid + lists all public IP addresses by VLAN ID + false + uuid + + + vpcid + List IPs belonging to the VPC + false + uuid + + + zoneid + lists all public IP addresses by zone ID + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocatin, Allocated and Releasing + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachinename + virtual machine name the ip address is assigned to (not null only for static nat Ip) + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateIso + Updates an ISO file. + false + + + id + the ID of the image file + true + uuid + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listOpenDaylightControllers + Lists OpenDyalight controllers + false + + + id + the ID of a OpenDaylight Controller + false + uuid + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + addBigSwitchBcfDevice + Adds a BigSwitch BCF Controller device + true + 4.6.0 + + + hostname + Hostname of ip address of the BigSwitch BCF Controller. + true + string + + + nat + NAT support of the BigSwitch BCF Controller. + true + boolean + + + password + Password of the BigSwitch BCF Controller. + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Username of the BigSwitch BCF Controller. + true + string + + + + + bcfdeviceid + device id of the BigSwitch BCF Controller + string + + + bigswitchdevicename + device name + string + + + hostname + the controller Ip address + string + + + nat + NAT support + boolean + + + password + the controller password + string + + + physicalnetworkid + the physical network to which this BigSwitch BCF segment belongs to + string + + + provider + name of the provider + string + + + username + the controller username + string + + + false + + + deleteCounter + Deletes a counter for VM auto scaling + true + + + id + the ID of the counter + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateDefaultNicForVirtualMachine + Changes the default NIC on a VM + true + + + nicid + NIC ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + issueOutOfBandManagementPowerAction + Initiates the specified power action to the host's out-of-band management interface + true + 4.9.0 + + + action + out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS + true + string + + + hostid + the ID of the host + true + uuid + + + timeout + optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting + false + long + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + deleteUser + Deletes a user for an account + false + + + id + id of the user to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + issueCertificate + Issues a client certificate using configured or provided CA plugin + true + 4.11.0 + + + csr + The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered + false + string + + + domain + Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN + false + string + + + duration + Certificate validity duration in number of days, when not provided the default configured value will be used + false + integer + + + ipaddress + Comma separated list of IP addresses, the certificate should be issued for + false + string + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + cacertificates + The CA certificate(s) + string + + + certificate + The client certificate + string + + + privatekey + Private key for the certificate + string + + + false + + + deleteNetworkDevice + Deletes network device. + false + + + id + Id of network device to delete + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createPortForwardingRule + Creates a port forwarding rule + true + + + ipaddressid + the IP address id of the port forwarding rule + true + uuid + + + privateport + the starting port of port forwarding rule's private port range + true + integer + + + protocol + the protocol for the port forwarding rule. Valid values are TCP or UDP. + true + string + + + publicport + the starting port of port forwarding rule's public port range + true + integer + + + virtualmachineid + the ID of the virtual machine for the port forwarding rule + true + uuid + + + cidrlist + the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use. + false + list + list + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + networkid + the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case). + false + uuid + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true + false + boolean + + + privateendport + the ending port of port forwarding rule's private port range + false + integer + + + publicendport + the ending port of port forwarding rule's private port range + false + integer + + + vmguestip + VM guest nic secondary IP address for the port forwarding rule + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateImageStore + Updates image store read-only status + false + 4.15.0 + + + id + Image Store UUID + true + uuid + + + readonly + If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration + true + boolean + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + dedicateZone + Dedicates a zones. + true + + + domainid + the ID of the containing domain + true + uuid + + + zoneid + the ID of the zone + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Zone is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the zone + string + + + domainid + the domain ID to which the Zone is dedicated + string + + + zoneid + the ID of the Zone + string + + + zonename + the Name of the Zone + string + + + false + + + prepareTemplate + load template into primary storage + false + + + templateid + template ID of the template to be prepared in primary storage(s). + true + uuid + + + zoneid + zone ID of the template to be prepared in primary storage(s). + true + uuid + + + storageid + storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + assignToLoadBalancerRule + Assigns virtual machine or a list of virtual machines to a load balancer rule. + true + + + id + the ID of the load balancer rule + true + uuid + + + virtualmachineids + the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3) + false + list + list + + + vmidipmap + VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75 + false + map + 4.4 + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateBackupOffering + Updates a backup offering. + false + 4.16.0 + + + id + The ID of the Backup Offering to be updated + true + uuid + + + allowuserdrivenbackups + Whether to allow user driven backups or not + false + boolean + + + description + The description of the Backup Offering to be updated + false + string + + + name + The name of the Backup Offering to be updated + false + string + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + archiveAlerts + Archive one or more alerts. + false + + + enddate + end date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the alerts + false + list + list + + + startdate + start date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + archive by alert type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAsyncJobs + Lists all pending asynchronous jobs for the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + startdate + The start date of the async job (use format "yyyy-MM-dd'T'HH:mm:ss'+'SSSS") + false + date + + + + + accountid + the account that executed the async command + string + + + cmd + the async command executed + string + + + completed + the completed date of the job + date + + + created + the created date of the job + date + + + jobinstanceid + the unique ID of the instance/entity object related to the job + string + + + jobinstancetype + the instance/entity object related to the job + string + + + jobprocstatus + the progress information of the PENDING job + integer + + + jobresult + the result reason + responseobject + + + jobresultcode + the result code for the job + integer + + + jobresulttype + the result type + string + + + jobstatus + the current job status-should be 0 for PENDING + integer + + + userid + the user that executed the async command + string + + + jobid + the ID of the async job + + + false + + + deleteCiscoVnmcResource + Deletes a Cisco Vnmc controller + false + + + resourceid + Cisco Vnmc resource ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addBrocadeVcsDevice + Adds a Brocade VCS Switch + true + + + hostname + Hostname of ip address of the Brocade VCS Switch. + true + string + + + password + Credentials to access the Brocade VCS Switch API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Credentials to access the Brocade VCS Switch API + true + string + + + + + brocadedevicename + device name + string + + + hostname + the principal switch Ip address + string + + + physicalnetworkid + the physical Network to which this Brocade VCS belongs to + string + + + provider + name of the provider + string + + + vcsdeviceid + device id of the Brocade Vcs + string + + + false + + + stopInternalLoadBalancerVM + Stops an Internal LB vm. + true + + + id + the ID of the internal lb vm + true + uuid + + + forced + Force stop the VM. The caller knows the VM is stopped. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + samlSso + SP initiated SAML Single Sign On + false + + + idpid + Identity Provider Entity ID + true + string + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + updateSecurityGroup + Updates a security group + false + 4.14.0.0 + + + id + The ID of the security group. + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + name + The new name of the security group. + false + string + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createDomain + Creates a domain + false + + + name + creates domain with this name + true + string + + + domainid + Domain UUID, required for adding domain from another Region + false + string + + + networkdomain + Network domain for networks in the domain + false + string + + + parentdomainid + assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed. + false + uuid + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + deleteTags + Deleting resource tag(s) + true + 4.0.0 + + + resourceids + Delete tags for resource id(s) + true + list + list + + + resourcetype + Delete tag by resource type + true + string + + + tags + Delete tags matching key/value pairs + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricTagType + create Tungsten-Fabric tag type + true + + + name + Tungsten-Fabric tag type name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric tag type name + string + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + login + Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired. + false + + + password + Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Username + true + string + + + domain + Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed. + false + string + + + domainId + The id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precendence + false + long + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + restartNetwork + Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules + true + + + id + The ID of the network to restart. + true + uuid + + + cleanup + If cleanup old network elements + false + boolean + + + livepatch + Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false. + false + 4.17.0 + boolean + + + makeredundant + Turn the network into a network with redundant routers. + false + 4.11.1 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listHypervisorCapabilities + Lists all hypervisor capabilities. + false + 3.0.0 + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + ID of the hypervisor capability + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the hypervisor capabilities row + string + + + hypervisor + the hypervisor type + hypervisortype + + + hypervisorversion + the hypervisor version + string + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached for this hypervisor + integer + + + maxguestslimit + the maximum number of guest vms recommended for this hypervisor + long + + + maxhostspercluster + the maximum number of Hosts per cluster for this hypervisor + integer + + + securitygroupenabled + true if security group is supported + boolean + + + storagemotionenabled + true if storage motion is supported + boolean + + + vmsnapshotenabled + true if VM snapshots are enabled for this hypervisor + boolean + + + false + + + addImageStore + Adds backup image store. + false + 4.2.0 + + + provider + the image store provider name + true + string + + + details + the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + name + the name for the image store + false + string + + + url + the URL for the image store + false + string + + + zoneid + the Zone ID for the image store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + revokeTemplateDirectDownloadCertificate + Revoke a direct download certificate from hosts in a zone + false + 4.13 + + + zoneid + (optional) zone to revoke certificate + true + uuid + + + hostid + (optional) the host ID to revoke certificate + false + uuid + + + hypervisor + (optional) hypervisor type + false + string + + + id + id of the certificate + false + uuid + + + name + (optional) alias of the SSL certificate + false + string + + + + + details + indicates the details in case of failure or host skipped + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + status + indicates if the certificate has been revoked from the host, failed or skipped + string + + + false + + + updateStorageCapabilities + Syncs capabilities of storage pools + false + 4.16.0 + + + id + Storage pool id + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + name + the name of the storage pool + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteProjectRole + Delete Project roles in CloudStack + false + 4.15.0 + + + id + ID of the project role to be deleted + true + uuid + + + projectid + ID of the project from where the role is to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + assignVolume + Changes ownership of a Volume from one account to another. + false + 4.18.0.0 + + + volumeid + The ID of the volume to be reassigned. + true + uuid + + + accountid + The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'. + false + uuid + + + projectid + The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'. + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteUserData + Deletes a userdata + false + 4.18 + + + id + the ID of the Userdata + true + uuid + + + account + an optional account for the userdata. Must be used with domainId. + false + string + + + domainid + an optional domainId for the userdata. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the userdata + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getSolidFireAccountId + Get SolidFire Account ID + false + + + accountid + CloudStack Account UUID + true + string + + + storageid + Storage Pool UUID + true + string + + + + + solidFireAccountId + SolidFire Account ID + long + + + false + + + quotaBalance + Create a quota balance statement + false + 4.7.0 + + + account + Account Id for which statement needs to be generated + true + string + + + domainid + If domain Id is given and the caller is domain admin then the statement is generated for domain. + true + uuid + + + accountid + List usage records for the specified account + false + uuid + + + enddate + End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + startdate + Start date range quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + false + date + + + + + account + account name + string + + + accountid + account id + long + + + domain + domain id + long + + + name + usage type name + string + + + quota + quota consumed + bigdecimal + + + type + usage type + int + + + unit + usage unit + string + + + false + + + listSupportedNetworkServices + Lists all network services provided by CloudStack or for the given Provider. + false + 3.0.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + network service provider name + false + string + + + service + network service name to list providers and capabilities of + false + string + + + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + false + + + listRolePermissions + Lists role permissions + false + 4.9.0 + + + roleid + ID of the role + false + uuid + + + + + id + the ID of the role permission + string + + + roleid + the ID of the role to which the role permission belongs + string + + + rolename + the name of the role to which the role permission belongs + string + + + false + + + revokeSecurityGroupIngress + Deletes a particular ingress rule from this security group + true + + + id + The ID of the ingress rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listDedicatedGuestVlanRanges + Lists dedicated guest vlan ranges + false + + + account + the account with which the guest VLAN range is associated. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain. + false + uuid + + + guestvlanrange + the dedicated guest vlan range + false + string + + + id + list dedicated guest vlan ranges by id + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + physical network id of the guest VLAN range + false + uuid + + + projectid + project who will own the guest VLAN range + false + uuid + + + zoneid + zone of the guest VLAN range + false + uuid + + + + + id + the ID of the guest VLAN range + string + + + account + the account of the guest VLAN range + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + guestvlanrange + the guest VLAN range + string + + + physicalnetworkid + the physical network of the guest vlan range + long + + + project + the project name of the guest vlan range + string + + + projectid + the project id of the guest vlan range + string + + + zoneid + the zone of the guest vlan range + long + + + false + + + listNetworkACLs + Lists all network ACL items + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + aclid + list network ACL items by ACL ID + false + uuid + + + action + list network ACL items by action + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists network ACL Item with the specified ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list network ACL items by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + protocol + list network ACL items by protocol + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + list network ACL items by traffic type - ingress or egress + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + addNetworkServiceProvider + Adds a network serviceProvider to a physical network + true + 3.0.0 + + + name + the name for the physical network service provider + true + string + + + physicalnetworkid + the Physical Network ID to add the provider to + true + uuid + + + destinationphysicalnetworkid + the destination Physical Network ID to bridge to + false + uuid + + + servicelist + the list of services to be enabled for this physical network service provider + false + list + list + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + deleteVpnGateway + Delete site to site vpn gateway + true + + + id + id of customer gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaTariffDelete + Marks a quota tariff as removed. + false + 4.18.0.0 + + + id + ID of the quota tariff + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + copyTemplate + Copies a template from one zone to another. + true + + + id + Template ID. + true + uuid + + + destzoneid + ID of the zone the template is being copied to. + false + uuid + + + destzoneids + 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. + false + list + list + + + sourcezoneid + 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. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createServiceOffering + Creates a service offering. + false + + + displaytext + the display text of the service offering + true + string + + + name + the name of the service offering + true + string + + + bytesreadrate + bytes read rate of the disk offering + false + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + long + + + byteswriterate + bytes write rate of the disk offering + false + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + long + + + cachemode + the cache mode to use for this disk offering. none, writeback or writethrough + false + 4.14 + string + + + cpunumber + the CPU number of the service offering + false + integer + + + cpuspeed + the CPU speed of the service offering in MHz. + false + integer + + + customized + Whether service offering size is custom or not + false + 4.13 + boolean + + + customizediops + whether compute offering iops is custom or not + false + 4.4 + boolean + + + deploymentplanner + The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used + false + string + + + diskofferingid + the ID of the disk offering to which service offering should be mapped + false + 4.17 + uuid + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + false + 4.17 + boolean + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + false + 4.16 + boolean + + + encryptroot + VMs using this offering require root volume encryption + false + 4.18 + boolean + + + hosttags + the host tag for this service offering. + false + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + false + 4.4 + integer + + + iopsreadrate + io requests read rate of the disk offering + false + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + long + + + iopswriterate + io requests write rate of the disk offering + false + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + long + + + issystem + is this a system vm offering + false + boolean + + + isvolatile + true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM + false + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + false + boolean + + + maxcpunumber + The maximum number of CPUs to be set with Custom Computer Offering + false + 4.13 + integer + + + maxiops + max iops of the compute offering + false + 4.4 + long + + + maxmemory + The maximum memory size of the custom service offering in MB + false + 4.13 + integer + + + memory + the total memory of the service offering in MB + false + integer + + + mincpunumber + The minimum number of CPUs to be set with Custom Computer Offering + false + 4.13 + integer + + + miniops + min iops of the compute offering + false + 4.4 + long + + + minmemory + The minimum memory size of the custom service offering in MB + false + 4.13 + integer + + + networkrate + data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtype + false + integer + + + offerha + the HA for the service offering + false + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + false + string + + + rootdisksize + the Root disk size in GB. + false + 4.15 + long + + + serviceofferingdetails + details for planner, used to store specific parameters + false + map + map + + + storagepolicy + Name of the storage policy defined at vCenter, this is applicable only for VMware + false + 4.15 + uuid + + + storagetype + the storage type of the service offering. Values are local and shared. + false + string + + + systemvmtype + the system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm". + false + string + + + tags + the tags for this service offering. + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + listNiciraNvpDeviceNetworks + lists network that are using a nicira nvp device + false + + + nvpdeviceid + nicira nvp device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + assignVirtualMachine + Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain. + false + 3.0.0 + + + virtualmachineid + id of the VM to be moved + true + uuid + + + account + account name of the new VM owner. + false + string + + + domainid + domain id of the new VM owner. + false + uuid + + + networkids + list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created. + false + list + list + + + projectid + an optional project for the new VM owner. + false + uuid + + + securitygroupids + list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group. + false + list + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteBigSwitchBcfDevice + delete a BigSwitch BCF Controller device + true + 4.6.0 + + + bcfdeviceid + BigSwitch device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + configureNetscalerLoadBalancer + configures a netscaler load balancer device + true + + + lbdeviceid + Netscaler load balancer device ID + true + uuid + + + inline + true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall + false + boolean + + + lbdevicecapacity + capacity of the device, Capacity will be interpreted as number of networks device can handle + false + long + + + lbdevicededicated + true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts + false + boolean + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + false + list + list + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + listOvsElements + Lists all available ovs elements. + false + + + enabled + list network offerings by enabled state + false + boolean + + + id + list ovs elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list ovs elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the ovs + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + deleteTungstenFabricServiceGroup + delete Tungsten-Fabric service group + true + + + servicegroupuuid + the uuid of Tungsten-Fabric service group + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + associateUcsProfileToBlade + associate a profile to a blade + true + + + bladeid + blade id + true + uuid + + + profiledn + profile dn + true + string + + + ucsmanagerid + ucs manager id + true + uuid + + + + + id + ucs blade id + string + + + bladedn + ucs blade dn + string + + + hostid + cloudstack host id this blade associates to + string + + + profiledn + associated ucs profile dn + string + + + ucsmanagerid + ucs manager id + string + + + false + + + validateUserTwoFactorAuthenticationCode + Checks the 2FA code for the user. + false + 4.18.0 + + + codefor2fa + two factor authentication code + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteUserFromProject + Deletes user from the project + true + 4.15.0 + + + projectid + ID of the project to remove the user from + true + uuid + + + userid + Id of the user to be removed from the project + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateVmwareDc + Updates a VMware datacenter details for a zone + false + 4.12.0 + + + zoneid + The zone ID + true + uuid + + + isrecursive + Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true. + false + boolean + + + name + VMware datacenter name. + false + string + + + password + The password for specified username. + false + string + + + username + The username required to connect to resource. + false + string + + + vcenter + The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + listNetscalerControlCenter + list control center + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + id + string + + + ipaddress + ncc_ip + string + + + numretries + num_retries + string + + + username + username + string + + + uuid + uuid + string + + + false + + + getRouterHealthCheckResults + Starts a router. + false + 4.14.0 + + + routerid + the ID of the router + true + uuid + + + performfreshchecks + if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched + false + boolean + + + + + healthchecks + the id of the router + list + + + routerid + the id of the router + string + + + false + + + resizeVolume + Resizes a volume + true + + + id + the ID of the disk volume + true + uuid + + + diskofferingid + new disk offering id + false + uuid + + + maxiops + New maximum number of IOPS + false + long + + + miniops + New minimum number of IOPS + false + long + + + shrinkok + Verify OK to Shrink + false + boolean + + + size + New volume size in GB + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteAffinityGroup + Deletes affinity group + true + + + account + the account of the affinity group. Must be specified with domain ID + false + string + + + domainid + the domain ID of account owning the affinity group + false + uuid + + + id + The ID of the affinity group. Mutually exclusive with name parameter + false + uuid + + + name + The name of the affinity group. Mutually exclusive with ID parameter + false + string + + + projectid + the project of the affinity group + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkServiceProvider + Deletes a Network Service Provider. + true + 3.0.0 + + + id + the ID of the network service provider + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkOffering + Deletes a network offering. + false + 3.0.0 + + + id + the ID of the network offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + dedicatePod + Dedicates a Pod. + true + + + domainid + the ID of the containing domain + true + uuid + + + podid + the ID of the Pod + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Pod is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the pod + string + + + domainid + the domain ID to which the Pod is dedicated + string + + + podid + the ID of the Pod + string + + + podname + the Name of the Pod + string + + + false + + + listNetworkDevice + List network devices + false + + + keyword + List by keyword + false + string + + + networkdeviceparameterlist + parameters for network device + false + map + map + + + networkdevicetype + Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the network device + string + + + false + + + updateStorageNetworkIpRange + Update a Storage network IP range, only allowed when no IPs in this range have been allocated. + true + 3.0.0 + + + id + UUID of storage network ip range + true + uuid + + + endip + the ending IP address + false + string + + + netmask + the netmask for storage network + false + string + + + startip + the beginning IP address + false + string + + + vlan + Optional. the vlan the ip range sits on + false + integer + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + listProjectRoles + Lists Project roles in CloudStack + false + 4.15.0 + + + projectid + List project role by project ID. + true + uuid + + + keyword + List by keyword + false + string + + + name + List project role by project role name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectroleid + List project role by project role ID. + false + uuid + + + + + projectid + the id of the project + string + + + false + + + deleteOpenDaylightController + Removes an OpenDyalight controler + true + + + id + OpenDaylight Controller ID + true + uuid + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + updateTemplate + Updates attributes of a template. + false + + + id + the ID of the image file + true + uuid + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetype + the type of the template + false + string + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateVpnConnection + Updates site to site vpn connection + true + 4.4 + + + id + id of vpn connection + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + createVlanIpRange + Creates a VLAN IP range. + false + + + account + account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted + false + string + + + domainid + domain ID of the account owning a VLAN + false + uuid + + + endip + the ending IP address in the VLAN IP range + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + forsystemvms + true if IP range is set to system vms, false if not + false + boolean + + + forvirtualnetwork + true if VLAN is of Virtual type, false if Direct + false + boolean + + + gateway + the gateway of the VLAN IP range + false + string + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6gateway + the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC + false + string + + + netmask + the netmask of the VLAN IP range + false + string + + + networkid + the network id + false + uuid + + + physicalnetworkid + the physical network id + false + uuid + + + podid + optional parameter. Have to be specified for Direct Untagged vlan only. + false + uuid + + + projectid + project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted + false + uuid + + + startip + the beginning IP address in the VLAN IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + vlan + the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged + false + string + + + zoneid + the Zone ID of the VLAN IP range + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + synchronizeTungstenFabricData + Synchronize Tungsten-Fabric data + false + + + id + provider id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listPaloAltoFirewallNetworks + lists network that are using Palo Alto firewall device + false + + + lbdeviceid + palo alto balancer device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getPathForVolume + Get the path associated with the provided volume UUID + false + + + volumeid + CloudStack Volume UUID + true + string + + + + + path + The path field for the volume + string + + + false + + + deleteTungstenFabricPolicy + delete Tungsten-Fabric policy + true + + + policyuuid + the Uuid of Tungsten-Fabric tag type + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listManagementServers + Lists management servers. + false + + + id + the id of the management server + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the management server + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the management server + string + + + javadistribution + the java distribution name running the management server process + string + + + javaversion + the version of the java distribution running the management server process + string + + + kernelversion + the running OS kernel version for this Management Server + string + + + lastboottime + the last time the host on which this Management Server runs was booted + date + + + lastserverstart + the last time this Management Server was started + date + + + lastserverstop + the last time this Management Server was stopped + date + + + name + the name of the management server + string + + + osdistribution + the name of the OS distribution running on the management server + string + + + state + the state of the management server + state + + + version + the version of the management server + string + + + false + + + listTungstenFabricPolicyRule + list Tungsten-Fabric policy + false + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + ruleuuid + the uuid of Tungsten-Fabric rule + false + string + + + zoneid + the ID of zone + false + uuid + + + + + action + Tungsten-Fabric policy action + string + + + destendport + Tungsten-Fabric policy destination end port + int + + + destipprefix + Tungsten-Fabric policy destination ip prefix + string + + + destipprefixlen + Tungsten-Fabric policy destination ip prefix length + int + + + destnetwork + Tungsten-Fabric policy destination network + string + + + deststartport + Tungsten-Fabric policy destination start port + int + + + direction + Tungsten-Fabric policy name + string + + + policyuuid + Tungsten-Fabric policy uuid + string + + + protocol + Tungsten-Fabric policy protocol + string + + + srcendport + Tungsten-Fabric policy source end port + int + + + srcipprefix + Tungsten-Fabric policy source ip prefix + string + + + srcipprefixlen + Tungsten-Fabric policy source ip prefix length + int + + + srcnetwork + Tungsten-Fabric policy source network + string + + + srcstartport + Tungsten-Fabric policy source start port + int + + + uuid + Tungsten-Fabric rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateInstanceGroup + Updates a vm group + false + + + id + Instance group ID + true + uuid + + + name + new instance group name + false + string + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + changeOfferingForVolume + Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering + true + 4.17 + + + id + the ID of the volume + true + uuid + + + diskofferingid + new disk offering id + true + uuid + + + automigrate + Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering + false + boolean + + + maxiops + New maximum number of IOPS for the custom disk offering + false + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + long + + + shrinkok + Verify OK to Shrink + false + boolean + + + size + New volume size in GB for the custom disk offering + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTemplateDirectDownloadCertificates + List the uploaded certificates for direct download templates + false + 4.17.0 + + + id + list direct download certificate by ID + false + uuid + + + keyword + List by keyword + false + string + + + listhosts + if set to true: include the hosts where the certificate is uploaded to + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the zone where certificates are uploaded + false + uuid + + + + + id + the direct download certificate id + string + + + alias + the direct download certificate alias + string + + + hostsmap + the hosts where the certificate is uploaded to + list + + + hypervisor + the hypervisor of the hosts where the certificate is uploaded + string + + + issuer + the direct download certificate issuer + string + + + serialnum + the direct download certificate serial num + string + + + subject + the direct download certificate subject + string + + + validity + the direct download certificate issuer + string + + + version + the direct download certificate version + string + + + zoneid + the zone id where the certificate is uploaded + string + + + zonename + the zone name where the certificate is uploaded + string + + + false + + + listUcsManagers + List ucs manager + false + + + id + the ID of the ucs manager + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the zone id + false + uuid + + + + + id + the ID of the ucs manager + string + + + name + the name of ucs manager + string + + + url + the url of ucs manager + string + + + zoneid + the zone ID of ucs manager + string + + + false + + + deleteLdapConfiguration + Remove an Ldap Configuration + false + 4.2.0 + + + hostname + Hostname + true + string + + + domainid + linked domain + false + uuid + + + port + port + false + integer + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port teh ldap server is running on + int + + + false + + + changeServiceForRouter + Upgrades domain router to a new service offering + false + + + id + The ID of the router + true + uuid + + + serviceofferingid + the service offering ID to apply to the domain router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateVolume + Updates the volume. + true + + + chaininfo + The chain info of the volume + false + 4.4 + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displayvolume + an optional field, whether to the display the volume to the end user or not. + false + boolean + + + id + the ID of the disk volume + false + uuid + + + name + new name of the volume + false + 4.16 + string + + + path + The path of the volume + false + string + + + state + The state of the volume + false + 4.3 + string + + + storageid + Destination storage pool UUID for the volume + false + 4.3 + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTrafficTypes + Lists traffic types of a given physical network. + false + 3.0.0 + + + physicalnetworkid + the Physical Network ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + createProjectRole + Creates a Project role + false + 4.15.0 + + + name + creates a project role with this unique name + true + string + + + projectid + ID of project where role is being created + true + uuid + + + description + The description of the Project role + false + string + + + + + projectid + the id of the project + string + + + false + + + updateAccount + Updates account information for the authenticated user + false + + + account + Current account name + false + string + + + accountdetails + Details for the account used to store specific parameters + false + map + map + + + domainid + The UUID of the domain where the account exists + false + uuid + + + id + Account UUID + false + uuid + + + networkdomain + Network domain for the account's networks; empty string will update domainName with NULL value + false + string + + + newname + New name for the account + false + string + + + roleid + The UUID of the dynamic role to set for the account + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + updateVirtualMachine + Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call. + false + + + id + The ID of the virtual machine + true + uuid + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + details + Details in key/value pairs. 'extraconfig' is not allowed to be passed in details. + false + map + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + displayname + user generated name + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + group of the virtual machine + false + string + + + haenable + true if high-availability is enabled for the virtual machine, false otherwise + false + boolean + + + instancename + instance name of the user vm + false + 4.4 + string + + + isdynamicallyscalable + true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting + false + boolean + + + name + new host name of the vm. The VM has to be stopped/started for this update to take affect + false + 4.4 + string + + + ostypeid + the ID of the OS type that best represents this VM. + false + uuid + + + securitygroupids + list of security group ids to be applied on the virtual machine. + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value + false + 4.16.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the userdata + false + 4.18 + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addSecondaryStorage + Adds secondary storage. + false + + + url + the URL for the secondary storage + true + string + + + zoneid + the Zone ID for the secondary storage + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + createIpv6FirewallRule + Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC) + true + + + networkid + The network of the VM the Ipv6 firewall rule will be created for + true + uuid + + + protocol + the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + true + string + + + cidrlist + the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + destcidrlist + the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of Ipv6 firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + startport + the starting port of Ipv6 firewall rule + false + integer + + + traffictype + the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + disableAccount + Disables an account + true + + + lock + If true, only lock the account; else disable the account + true + boolean + + + account + Disables specified account. + false + string + + + domainid + Disables specified account in this domain. + false + uuid + + + id + Account id + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + listDomains + Lists domains and provides detailed information for listed domains + false + + + details + comma separated list of domain details requested, value can be a list of [ all, resource, min] + false + list + list + + + id + List domain by domain ID. + false + uuid + + + keyword + List by keyword + false + string + + + level + List domains by domain level. + false + integer + + + listall + 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 + false + boolean + + + name + List domain by domain name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for domains + false + boolean + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + updateNetwork + Updates a network + true + + + id + the ID of the network + true + uuid + + + changecidr + Force update even if CIDR type is different + false + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + false + boolean + + + displaytext + the new display text for the network + false + string + + + dns1 + the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone + false + 4.18.0 + string + + + forced + Setting this to true will cause a forced network update, + false + boolean + + + guestvmcidr + CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR + false + string + + + hideipaddressusage + when true ip address usage for the network will not be exported by the listUsageRecords API + false + boolean + + + ip6dns1 + the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone + false + 4.18.0 + string + + + name + the new name for the network + false + string + + + networkdomain + network domain + false + string + + + networkofferingid + network offering ID + false + uuid + + + privatemtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + updateinsequence + if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider + false + boolean + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listBackups + Lists VM backups + false + 4.14.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + id of the backup + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + virtualmachineid + id of the VM + false + uuid + + + zoneid + list backups by zone id + false + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + string + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + listUsageTypes + List Usage Types + false + + + + description + description of usage type + string + + + usagetypeid + usage type + integer + + + false + + + resetUserDataForVirtualMachine + Resets the UserData for virtual machine. The virtual machine must be in a "Stopped" state. [async] + false + + + id + The ID of the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the virtual machine + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + map + + + userdataid + the ID of the userdata + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listBackupProviders + Lists Backup and Recovery providers + false + 4.14.0 + + + name + List Backup and Recovery provider by name + false + string + + + + + description + the description of the CA service provider + string + + + name + the CA service provider name + string + + + false + + + deleteTemplate + Deletes a template from the system. All virtual machines using the deleted template will not be affected. + true + + + id + the ID of the template + true + uuid + + + forced + Force delete a template. + false + 4.9+ + boolean + + + zoneid + the ID of zone of the template + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkACLLists + Lists all network ACLs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists network ACL with the specified ID. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list network ACLs by specified name + false + string + + + networkid + list network ACLs by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + list network ACLs by VPC ID + false + uuid + + + + + id + the ID of the ACL + string + + + description + Description of the ACL + string + + + fordisplay + is ACL for display to the regular user + 4.4 + boolean + + + name + the Name of the ACL + string + + + vpcid + Id of the VPC this ACL is associated with + string + + + vpcname + Name of the VPC this ACL is associated with + string + + + false + + + archiveSnapshot + Archives (moves) a snapshot on primary storage to secondary storage + true + + + id + The ID of the snapshot + true + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteVPC + Deletes a VPC + true + + + id + the ID of the VPC + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateVpnGateway + Updates site to site vpn local gateway + true + 4.4 + + + id + id of customer gateway + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + releaseDedicatedGuestVlanRange + Releases a dedicated guest vlan range to the system + true + + + id + the ID of the dedicated guest vlan range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSecurityGroup + Deletes security group + false + + + account + the account of the security group. Must be specified with domain ID + false + string + + + domainid + the domain ID of account owning the security group + false + uuid + + + id + The ID of the security group. Mutually exclusive with name parameter + false + uuid + + + name + The ID of the security group. Mutually exclusive with id parameter + false + string + + + projectid + the project of the security group + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateVirtualMachine + Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default + false + 4.16.0 + boolean + + + hostid + Destination Host ID to migrate VM to. + false + uuid + + + storageid + Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteKubernetesSupportedVersion + Deletes a Kubernetes cluster + true + + + id + the ID of the Kubernetes supported version + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTemplate + Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it. + true + + + displaytext + the display text of the template. This is usually used for display purposes. + true + string + + + name + the name of the template + true + string + + + ostypeid + the ID of the OS Type that best represents the OS of this template. + true + uuid + + + bits + 32 or 64 bit + false + integer + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if this template is a public template, false otherwise + false + boolean + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + create template for the project + false + uuid + + + requireshvm + true if the template requires HVM, false otherwise + false + boolean + + + snapshotid + the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in + false + uuid + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + url + Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server + false + string + + + virtualmachineid + Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal + false + uuid + + + volumeid + the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listBaremetalRct + list baremetal rack configuration + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + id of rct + string + + + url + url + string + + + false + + + restoreBackup + Restores an existing stopped or deleted VM using a VM backup + true + 4.14.0 + + + id + ID of the backup + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + uploadCustomCertificate + Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself. + true + + + certificate + The certificate to be uploaded. + true + string + + + domainsuffix + DNS domain suffix that the certificate is granted for. + true + string + + + id + An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3 + false + integer + + + name + A name / alias for the certificate. + false + string + + + privatekey + The private key for the attached certificate. + false + string + + + + + message + message of the certificate upload operation + string + + + false + + + listDedicatedClusters + Lists dedicated clusters. + false + + + account + the name of the account associated with the cluster. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated clusters by affinity group + false + uuid + + + clusterid + the ID of the cluster + false + uuid + + + domainid + the ID of the domain associated with the cluster + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the cluster + string + + + affinitygroupid + the Dedication Affinity Group ID of the cluster + string + + + clusterid + the ID of the cluster + string + + + clustername + the name of the cluster + string + + + domainid + the domain ID of the cluster + string + + + false + + + listCAProviders + Lists available certificate authority providers in CloudStack + false + 4.11.0 + + + name + List CA service provider by name + false + string + + + + + description + the description of the CA service provider + string + + + name + the CA service provider name + string + + + false + + + deleteVpnCustomerGateway + Delete site to site vpn customer gateway + true + + + id + id of customer gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaUpdate + Update quota calculations, alerts and statements + false + 4.7.0 + + + + updated_on + timestamp when the run got over + date + + + false + + + enableOutOfBandManagementForCluster + Enables out-of-band management for a cluster + true + 4.9.0 + + + clusterid + the ID of the cluster + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + acquirePodIpAddress + Allocates IP addresses in respective Pod of a Zone + false + + + zoneid + the ID of the zone + true + string + + + podid + Pod ID + false + string + + + + + id + the ID of the pod the IP address + long + + + cidr + CIDR of the Pod + string + + + gateway + Gateway for Pod + string + + + hostmac + MAC address of the pod the IP + long + + + ipaddress + Allocated IP address + string + + + nicid + the ID of the nic + long + + + podid + the ID of the pod the IP address belongs to + long + + + false + + + listPortForwardingRules + Lists all port forwarding rules for an IP address. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the port forwarding services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list port forwarding rules for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listTungstenFabricNetwork + list Tungsten-Fabric network + false + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false + false + boolean + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric network name + string + + + uuid + Tungsten-Fabric network uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateTemplatePermissions + Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them. + false + + + id + the template ID + true + uuid + + + accounts + a comma delimited list of accounts within caller's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + isextractable + true if the template/iso is extractable, false other wise. Can be set only by root admin + false + boolean + + + isfeatured + true for featured template/iso, false otherwise + false + boolean + + + ispublic + true for public template/iso, false for private templates/isos + false + boolean + + + op + permission operator (add, remove, reset) + false + string + + + projectids + a comma delimited list of projects. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTrafficMonitors + List traffic monitor Hosts. + false + + + zoneid + zone Id + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the external firewall + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + resetPasswordForVirtualMachine + Resets the password for virtual machine. The virtual machine must be in a "Stopped" state and the template must already support this feature for this command to take effect. [async] + true + + + id + The ID of the virtual machine + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updatePortForwardingRule + Updates a port forwarding rule. Only the private port and the virtual machine can be updated. + true + + + id + the ID of the port forwarding rule + true + 4.4 + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + privateendport + the private end port of the port forwarding rule + false + integer + + + privateport + the private start port of the port forwarding rule + false + integer + + + virtualmachineid + the ID of the virtual machine for the port forwarding rule + false + uuid + + + vmguestip + VM guest nic Secondary ip address for the port forwarding rule + false + 4.5 + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listBrocadeVcsDevices + Lists Brocade VCS Switches + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + vcsdeviceid + Brocade VCS switch ID + false + uuid + + + + + brocadedevicename + device name + string + + + hostname + the principal switch Ip address + string + + + physicalnetworkid + the physical Network to which this Brocade VCS belongs to + string + + + provider + name of the provider + string + + + vcsdeviceid + device id of the Brocade Vcs + string + + + false + + + linkDomainToLdap + link an existing cloudstack domain to group or OU in ldap + false + 4.6.0 + + + accounttype + Type of the account to auto import. Specify 0 for user and 2 for domain admin + true + integer + + + domainid + The id of the domain which has to be linked to LDAP. + true + uuid + + + type + type of the ldap name. GROUP or OU + true + string + + + admin + domain admin username in LDAP + false + string + + + ldapdomain + name of the group or OU in LDAP + false + string + + + name + name of the group or OU in LDAP + false + string + + + + + accountid + Domain Admin accountId that is created + string + + + accounttype + Type of the account to auto import + int + + + domainid + id of the Domain which is linked to LDAP + string + + + ldapdomain + name of the group or OU in LDAP which is linked to the domain + string + + + name + name of the group or OU in LDAP which is linked to the domain + string + + + type + type of the name in LDAP which is linke to the domain + string + + + false + + + associateIpAddress + Acquires and associates a public IP to an account. + true + + + account + the account to associate with this IP address + false + string + + + domainid + the ID of the domain to associate with this IP address + false + uuid + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + 4.4 + boolean + + + ipaddress + IP Address to be associated + false + string + + + isportable + should be set to true if public IP is required to be transferable across zones, if not specified defaults to false + false + boolean + + + networkid + The network this IP address should be associated to. + false + uuid + + + projectid + Deploy VM for the project + false + uuid + + + regionid + region ID from where portable IP is to be associated. + false + integer + + + vpcid + the VPC you want the IP address to be associated with + false + uuid + + + zoneid + the ID of the availability zone you want to acquire an public IP address from + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocatin, Allocated and Releasing + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachinename + virtual machine name the ip address is assigned to (not null only for static nat Ip) + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + getSolidFireVolumeAccessGroupIds + Get the SF Volume Access Group IDs + false + + + clusterid + Cluster UUID + true + string + + + storageid + Storage Pool UUID + true + string + + + + + solidFireVolumeAccessGroupIds + SolidFire Volume Access Group Ids + long[] + + + false + + + setupUserTwoFactorAuthentication + Setup the 2FA for the user. + false + 4.18.0 + + + enable + Enabled by default, provide false to disable 2FA + false + boolean + + + provider + two factor authentication code + false + string + + + userid + optional: the id of the user for which 2FA has to be disabled + false + uuid + + + + + id + the user ID + string + + + accountid + the account ID of the user + string + + + secretcode + secret code that needs to be registered with authenticator + string + + + username + the user name + string + + + false + + + deleteVpnConnection + Delete site to site vpn connection + true + + + id + id of vpn connection + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + resetSSHKeyForVirtualMachine + Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async] + true + + + id + The ID of the virtual machine + true + uuid + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs to be used to login to the virtual machine + false + list + 4.17 + list + + + projectid + an optional project for the ssh key + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createNetworkACL + Creates a ACL rule in the given network (the network has to belong to VPC) + true + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + true + string + + + aclid + The network of the VM the ACL will be created for + false + uuid + + + action + scl entry action, allow or deny + false + string + + + cidrlist + the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of ACL + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + networkid + The network of the VM the ACL will be created for + false + uuid + + + number + The number of the ACL item, its ordering + false + integer + + + reason + A description indicating why the ACL rule is required. + false + string + + + startport + the starting port of ACL + false + integer + + + traffictype + the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listVpnCustomerGateways + Lists site to site vpn customer gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + id of the customer gateway + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + deleteManagementNetworkIpRange + Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated. + true + 4.11.0.0 + + + endip + The ending IP address. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + startip + The starting IP address. + true + string + + + vlan + The vlan id the ip range sits on + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addKubernetesSupportedVersion + Add a supported Kubernetes version + false + + + mincpunumber + the minimum number of CPUs to be set with the Kubernetes version + true + integer + + + minmemory + the minimum RAM size in MB to be set with the Kubernetes version + true + integer + + + semanticversion + the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format + true + string + + + checksum + the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + name + the name of the Kubernetes supported version + false + string + + + url + the URL of the binaries ISO for Kubernetes supported version + false + string + + + zoneid + the ID of the zone in which Kubernetes supported version will be available + false + uuid + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + deleteKubernetesCluster + Deletes a Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAndSwitchSamlAccount + Lists and switches to other SAML accounts owned by the SAML user + false + + + domainid + Domain uuid + false + uuid + + + userid + User uuid + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createGlobalLoadBalancerRule + Creates a global load balancer rule + true + + + gslbdomainname + domain name for the GSLB service. + true + string + + + gslbservicetype + GSLB service type (tcp, udp, http) + true + string + + + name + name of the load balancer rule + true + string + + + regionid + region where the global load balancer is going to be created. + true + integer + + + account + the account associated with the global load balancer. Must be used with the domainId parameter. + false + string + + + description + the description of the load balancer rule + false + string + + + domainid + the domain ID associated with the load balancer + false + uuid + + + gslblbmethod + load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin' + false + string + + + gslbstickysessionmethodname + session sticky method (sourceip) if not specified defaults to sourceip + false + string + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + linkUserDataToTemplate + Link or unlink a userdata to a template. + false + 4.18.0 + + + isoid + the ID of the ISO for the virtual machine + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + userdataid + the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO + false + uuid + + + userdatapolicy + an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride + false + string + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteNetscalerLoadBalancer + delete a netscaler load balancer device + true + + + lbdeviceid + netscaler load balancer device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listGlobalLoadBalancerRules + Lists load balancer rules. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the global load balancer rule + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + regionid + region ID + false + integer + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + listTags + List resource tag(s) + false + 4.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + customer + list by customer name + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + key + list by key + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + list by resource id + false + string + + + resourcetype + list by resource type + false + string + + + value + list by value + false + string + + + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + false + + + releaseDedicatedCluster + Release the dedication for cluster + true + + + clusterid + the ID of the Cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getKubernetesClusterConfig + Get Kubernetes cluster config + false + + + id + the ID of the Kubernetes cluster + false + uuid + + + + + id + the id of the container cluster + string + + + configdata + the config data of the cluster + string + + + name + Name of the container cluster + string + + + false + + + deleteDiskOffering + Updates a disk offering. + false + + + id + ID of the disk offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVirtualRouterElement + Create a virtual router element. + true + + + nspid + the network service provider ID of the virtual router element + true + uuid + + + providertype + The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + createVPC + Creates a VPC + true + + + cidr + the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR + true + string + + + displaytext + the display text of the VPC + true + string + + + name + the name of the VPC + true + string + + + vpcofferingid + the ID of the VPC offering + true + uuid + + + zoneid + the ID of the availability zone + true + uuid + + + account + the account associated with the VPC. Must be used with the domainId parameter. + false + string + + + dns1 + the first IPv4 DNS for the VPC + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the VPC + false + 4.18.0 + string + + + domainid + the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain. + false + uuid + + + fordisplay + an optional field, whether to the display the vpc to the end user or not + false + 4.4 + boolean + + + ip6dns1 + the first IPv6 DNS for the VPC + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + false + 4.18.0 + string + + + networkdomain + VPC network domain. All networks inside the VPC will belong to this domain + false + string + + + projectid + create VPC for the project + false + uuid + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + start + If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default. + false + 4.3 + boolean + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteAutoScalePolicy + Deletes a autoscale policy. + true + + + id + the ID of the autoscale policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteRole + Deletes a role + false + 4.9.0 + + + id + ID of the role + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteCiscoNexusVSM + delete a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listInternalLoadBalancerVMs + List internal LB VMs. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fetchhealthcheckresults + if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false + false + 4.14 + boolean + + + forvpc + if true is passed for this parameter, list only VPC Internal LB VMs + false + boolean + + + hostid + the host ID of the Internal LB VM + false + uuid + + + id + the ID of the Internal LB VM + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the Internal LB VM + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the Internal LB VM + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + the state of the Internal LB VM + false + string + + + vpcid + List Internal LB VMs by VPC + false + uuid + + + zoneid + the Zone ID of the Internal LB VM + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listCiscoVnmcResources + Lists Cisco VNMC controllers + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + resourceid + Cisco VNMC resource ID + false + uuid + + + + false + + + removeResourceDetail + Removes detail for the Resource. + true + + + resourceid + Delete details for resource id + true + string + + + resourcetype + Delete detail by resource type + true + string + + + key + Delete details matching key/value pairs + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listOsTypes + Lists all supported OS types for this cloud. + false + + + description + list os by description + false + 3.0.1 + string + + + id + list by Os type Id + false + uuid + + + keyword + List by keyword + false + string + + + oscategoryid + list by Os Category id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + isuserdefined + is the guest OS user defined + boolean + + + oscategoryid + the ID of the OS category + string + + + false + + + revokeSecurityGroupEgress + Deletes a particular egress rule from this security group + true + 3.0.0 + + + id + The ID of the egress rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + uploadResourceIcon + Uploads an icon for the specified resource(s) + false + 4.16.0.0 + + + base64image + Base64 string representation of the resource icon/image + true + string + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + removeGuestOs + Removes a Guest OS from listing. + true + 4.4.0 + + + id + ID of the guest OS + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateKubernetesSupportedVersion + Update a supported Kubernetes version + false + + + id + the ID of the Kubernetes supported version + true + uuid + + + state + the enabled or disabled state of the Kubernetes supported version + true + string + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + detachIso + Detaches any ISO file (if any) currently attached to a virtual machine. + true + + + virtualmachineid + The ID of the virtual machine + true + uuid + + + forced + If true, ejects the ISO before detaching on VMware. Default: false + false + 4.15.1 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createGuestNetworkIpv6Prefix + Creates a guest network IPv6 prefix. + true + 4.17.0.0 + + + prefix + The /56 or higher IPv6 CIDR for network prefix. + true + string + + + zoneid + UUID of zone to which the IPv6 prefix belongs to. + true + uuid + + + + + id + id of the guest IPv6 prefix + string + + + availablesubnets + count of the available IPv6 subnets for the prefix. + integer + + + created + date when this IPv6 prefix was created. + date + + + prefix + guest IPv6 prefix + string + + + totalsubnets + count of the total IPv6 subnets for the prefix. + integer + + + usedsubnets + count of the used IPv6 subnets for the prefix. + integer + + + zoneid + id of zone to which the IPv6 prefix belongs to. + string + + + false + + + deletePaloAltoFirewall + delete a Palo Alto firewall device + true + + + fwdeviceid + Palo Alto firewall device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deletePod + Deletes a Pod. + false + + + id + the ID of the Pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricProviders + Lists Tungsten-Fabric providers + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + false + uuid + + + + + name + Tungsten-Fabric provider name + string + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + tungstengateway + Tungsten-Fabric provider gateway + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + string + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + string + + + tungstenproviderport + Tungsten-Fabric provider port + string + + + tungstenprovideruuid + Tungsten-Fabric provider uuid + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listDeploymentPlanners + Lists all DeploymentPlanners available. + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + Deployment Planner name + string + + + false + + + prepareHostForMaintenance + Prepares a host for maintenance. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + hypervisortype + + + hypervisorversion + the hypervisor version + string + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteCluster + Deletes a cluster. + false + + + id + the cluster ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createRole + Creates a role + false + 4.9.0 + + + name + Creates a role with this unique name + true + string + + + description + The description of the role + false + string + + + roleid + ID of the role to be cloned from. Either roleid or type must be passed in + false + uuid + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + removeRegion + Removes specified region + false + + + id + ID of the region to delete + true + integer + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getVolumeiScsiName + Get Volume's iSCSI Name + false + + + volumeid + CloudStack Volume UUID + true + string + + + + + volumeiScsiName + Volume iSCSI Name + string + + + false + + + getUploadParamsForVolume + Upload a data disk to the cloudstack cloud. + false + 4.6.0 + + + format + the format for the volume/template. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume/template + true + string + + + zoneid + the ID of the zone the volume/template is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + checksum + the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + diskofferingid + the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown. + false + uuid + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + imagestoreuuid + Image store uuid + false + string + + + projectid + Upload volume/template for the project + false + uuid + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + updateAutoScaleVmGroup + Updates an existing autoscale vm group. + true + + + id + the ID of the autoscale group + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the group to the end user or not + false + 4.4 + boolean + + + interval + the frequency in which the performance counters to be collected + false + integer + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + false + integer + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + false + integer + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + scaledownpolicyids + list of scaledown autoscale policies + false + list + list + + + scaleuppolicyids + list of scaleup autoscale policies + false + list + list + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + updateAutoScaleVmProfile + Updates an existing autoscale vm profile. + true + + + id + the ID of the autoscale vm profile + true + uuid + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + false + uuid + + + counterparam + counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161 + false + map + map + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + false + integer + + + fordisplay + an optional field, whether to the display the profile to the end user or not + false + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. +Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 . +Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". + false + map + 4.18.0 + map + + + serviceofferingid + the service offering of the auto deployed virtual machine + false + 4.18.0 + uuid + + + templateid + the template of the auto deployed virtual machine + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value + false + 4.18.0 + string + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base 64 encoded VM user data + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + enableAutoScaleVmGroup + Enables an AutoScale Vm Group + true + + + id + the ID of the autoscale group + true + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + deleteSnapshot + Deletes a snapshot of a disk volume. + true + + + id + The ID of the snapshot + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listGuestNetworkIpv6Prefixes + Lists guest network IPv6 prefixes + false + 4.17.0 + + + id + UUID of the IPv6 prefix. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + UUID of zone to which the IPv6 prefix belongs to. + false + uuid + + + + + id + id of the guest IPv6 prefix + string + + + availablesubnets + count of the available IPv6 subnets for the prefix. + integer + + + created + date when this IPv6 prefix was created. + date + + + prefix + guest IPv6 prefix + string + + + totalsubnets + count of the total IPv6 subnets for the prefix. + integer + + + usedsubnets + count of the used IPv6 subnets for the prefix. + integer + + + zoneid + id of zone to which the IPv6 prefix belongs to. + string + + + false + + + listVirtualMachines + List the virtual machines owned by the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + clusterid + the cluster ID + false + 4.16.0 + uuid + + + details + 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 + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hostid + the host ID + false + uuid + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + storageid + the storage ID where vm's volumes belong to + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateGuestOsMapping + Updates the information about Guest OS to Hypervisor specific name mapping + true + 4.4.0 + + + id + UUID of the Guest OS to hypervisor name Mapping + true + uuid + + + osnameforhypervisor + Hypervisor specific name for this Guest OS + true + string + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + deleteTungstenFabricTag + delete Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listDiskOfferings + Lists all available disk offerings. + false + + + domainid + list only resources belonging to the domain specified + false + uuid + + + encrypt + listed offerings support disk encryption + false + 4.18 + boolean + + + id + ID of the disk offering + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the disk offering + false + string + + + page + false + integer + + + pagesize + false + integer + + + storageid + The ID of the storage pool, tags of the storage pool are used to filter the offerings + false + 4.17 + uuid + + + volumeid + The ID of the volume, tags of the volume are used to filter the offerings + false + 4.17 + uuid + + + zoneid + id of zone disk offering is associated with + false + 4.13 + uuid + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + storagetype + the storage type for this disk offering + string + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + updateHostPassword + Update password of a host/pool on management server. + false + + + password + the new password for the host/cluster + true + string + + + username + the username for the host/cluster + true + string + + + clusterid + the cluster ID + false + uuid + + + hostid + the host ID + false + uuid + + + update_passwd_on_host + if the password should also be updated on the hosts + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createPortableIpRange + adds a range of portable public IP's to a region + true + 4.2.0 + + + endip + the ending IP address in the portable IP range + true + string + + + gateway + the gateway for the portable IP range + true + string + + + netmask + the netmask of the portable IP range + true + string + + + regionid + Id of the Region + true + integer + + + startip + the beginning IP address in the portable IP range + true + string + + + vlan + VLAN id, if not specified defaulted to untagged + false + string + + + + + id + portable IP range ID + string + + + endip + the end ip of the portable IP range + string + + + gateway + the gateway of the VLAN IP range + string + + + netmask + the netmask of the VLAN IP range + string + + + regionid + Region Id in which portable ip range is provisioned + integer + + + startip + the start ip of the portable IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + portableipaddress(*) + List of portable IP and association with zone/network/vpc details that are part of GSLB rule + + + accountid + the account ID the portable IP address is associated with + string + + + allocated + date the portal IP address was acquired + date + + + domainid + the domain ID the portable IP address is associated with + string + + + ipaddress + public IP address + string + + + networkid + the ID of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + regionid + Region Id in which global load balancer is created + integer + + + state + State of the ip address. Can be: Allocatin, Allocated and Releasing + string + + + vpcid + VPC the ip belongs to + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + list + + + false + + + updateCluster + Updates an existing cluster + false + + + id + the ID of the Cluster + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + clustername + the cluster name + false + string + + + clustertype + hypervisor type of the cluster + false + string + + + hypervisor + hypervisor type of the cluster + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + deleteCiscoAsa1000vResource + Deletes a Cisco ASA 1000v appliance + false + + + resourceid + Cisco ASA 1000v resource ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + upgradeKubernetesCluster + Upgrades a running Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + kubernetesversionid + the ID of the Kubernetes version for upgrade + true + uuid + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + listStorageProviders + Lists storage providers. + false + + + type + the type of storage provider: either primary or image + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + the name of the storage provider + string + + + type + the type of the storage provider: primary or image provider + string + + + false + + + listUcsProfiles + List profile in ucs manager + false + + + ucsmanagerid + the id for the ucs manager + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + ucsdn + ucs profile dn + string + + + false + + + getUserKeys + This command allows the user to query the seceret and API keys for the account + false + 4.10.0 + + + id + ID of the user whose keys are required + true + uuid + + + + + apikey + the api key of the registered user + string + + + secretkey + the secret key of the registered user + string + + + false + + + updateGlobalLoadBalancerRule + update global load balancer rules. + true + + + id + the ID of the global load balancer rule + true + uuid + + + description + the description of the load balancer rule + false + string + + + gslblbmethod + load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin' + false + string + + + gslbstickysessionmethodname + session sticky method (sourceip) if not specified defaults to sourceip + false + string + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + listProjects + Lists projects and provides detailed information for listed projects + false + 3.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + details + comma separated list of project details requested, value can be a list of [ all, resource, min] + false + list + list + + + displaytext + list projects by display text + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list projects by project ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list projects by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for projects + false + boolean + + + state + list projects by state + false + string + + + tags + List projects by tags (key/value pairs) + false + map + map + + + username + List projects by username + false + string + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createCondition + Creates a condition for VM auto scaling + true + + + counterid + ID of the Counter. + true + uuid + + + relationaloperator + Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE. + true + string + + + threshold + Value for which the Counter will be evaluated with the Operator selected. + true + long + + + account + the account of the condition. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID of the account. + false + uuid + + + projectid + an optional project for condition + false + uuid + + + + + id + the id of the Condition + string + + + account + the owner of the Condition. + string + + + counter + Details of the Counter. + counterresponse + + + counterid + the Id of the Counter. + string + + + countername + the Name of the Counter. + string + + + domain + the domain name of the owner. + string + + + domainid + the domain id of the Condition owner + string + + + project + the project name of the Condition + string + + + projectid + the project id of the Condition. + string + + + relationaloperator + Relational Operator to be used with threshold. + string + + + threshold + Threshold Value for the counter. + long + + + zoneid + zone id of counter + string + + + false + + + createAccount + Creates an account + false + + + email + email + true + string + + + firstname + firstname + true + string + + + lastname + lastname + true + string + + + password + Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Unique username. + true + string + + + account + Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accountid + Account UUID, required for adding account from external provisioning system + false + string + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + Creates the user under the specified domain. + false + uuid + + + networkdomain + Network domain for the account's networks + false + string + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + authorizeSamlSso + Allow or disallow a user to use SAML SSO + false + + + enable + If true, authorizes user to be able to use SAML for Single Sign. If False, disable user to user SAML SSO. + true + boolean + + + userid + User uuid + true + uuid + + + entityid + The Identity Provider ID the user is allowed to get single signed on from + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + revertToVMSnapshot + Revert VM from a vmsnapshot. + true + 4.2.0 + + + vmsnapshotid + The ID of the vm snapshot + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addGuestOs + Add a new guest OS type + true + 4.4.0 + + + details + Map of (key/value pairs) + true + map + map + + + oscategoryid + ID of Guest OS category + true + uuid + + + osdisplayname + Unique display name for Guest OS + true + string + + + name + Optional name for Guest OS + false + string + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + isuserdefined + is the guest OS user defined + boolean + + + oscategoryid + the ID of the OS category + string + + + false + + + listHostTags + Lists host tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the host tag + string + + + hostid + the host ID of the host tag + long + + + name + the name of the host tag + string + + + false + + + addAnnotation + add an annotation. + false + 4.11 + + + adminsonly + the annotation is visible for admins only + false + 4.16.0 + boolean + + + annotation + the annotation text + false + string + + + entityid + the id of the entity to annotate + false + string + + + entitytype + the entity type (only HOST is allowed atm) + false + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + removeGuestOsMapping + Removes a Guest OS Mapping. + true + 4.4.0 + + + id + ID of the guest OS mapping + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricServiceGroup + create Tungsten-Fabric service group + true + + + endport + Tungsten-Fabric service group end port + true + integer + + + name + Tungsten-Fabric service group name + true + string + + + protocol + Tungsten-Fabric service group protocol + true + string + + + startport + Tungsten-Fabric service group start port + true + integer + + + zoneid + the ID of zone + true + uuid + + + + + endport + Tungsten-Fabric service group end port + int + + + name + Tungsten-Fabric service group name + string + + + protocol + Tungsten-Fabric service group protocol + string + + + startport + Tungsten-Fabric service group start port + int + + + uuid + Tungsten-Fabric service group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listIdps + Returns list of discovered SAML Identity Providers + false + + + + id + The IdP Entity ID + string + + + orgName + The IdP Organization Name + string + + + orgUrl + The IdP Organization URL + string + + + false + + + registerIso + Registers an existing ISO into the CloudStack Cloud. + false + + + displaytext + the display text of the ISO. This is usually used for display purposes. + true + string + + + name + the name of the ISO + true + string + + + url + the URL to where the ISO is currently being hosted + true + string + + + zoneid + the ID of the zone you wish to register the ISO to. + true + uuid + + + account + an optional account name. Must be used with domainId. + false + string + + + bootable + true if this ISO is bootable. If not passed explicitly its assumed to be true + false + boolean + + + checksum + the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + directdownload + true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + imagestoreuuid + Image store UUID + false + string + + + isdynamicallyscalable + true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory + false + boolean + + + isextractable + true if the ISO or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if you want this ISO to be featured + false + boolean + + + ispublic + true if you want to register the ISO to be publicly available to all users, false otherwise. + false + boolean + + + ostypeid + the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed + false + uuid + + + passwordenabled + true if password reset feature is supported; default is false + false + boolean + + + projectid + Register ISO for the project + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listCiscoAsa1000vResources + Lists Cisco ASA 1000v appliances + false + + + hostname + Hostname or ip address of the Cisco ASA 1000v appliance. + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + resourceid + Cisco ASA 1000v resource ID + false + uuid + + + + false + + + deployNetscalerVpx + Creates new NS Vpx + true + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + networkid + The network this ip address should be associated to. + false + uuid + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + listElastistorVolume + Lists the volumes of elastistor + false + + + id + the ID of the account + true + string + + + + + id + the id of the volume + string + + + compression + compression + string + + + deduplication + deduplication + string + + + graceallowed + graceallowed + string + + + name + the name of the volume + string + + + sync + syncronization + string + + + false + + + deletePortableIpRange + deletes a range of portable public IP's associated with a region + true + + + id + Id of the portable ip range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addBaremetalPxeKickStartServer + add a baremetal pxe server + true + + + password + Credentials to reach external pxe device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + pxeservertype + type of pxe device + true + string + + + tftpdir + Tftp root directory of PXE server + true + string + + + url + URL of the external pxe device + true + string + + + username + Credentials to reach external pxe device + true + string + + + podid + Pod Id + false + uuid + + + + + tftpdir + Tftp root directory of PXE server + string + + + false + + + listNiciraNvpDevices + Lists Nicira NVP devices + false + + + keyword + List by keyword + false + string + + + nvpdeviceid + nicira nvp device ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + hostname + the controller Ip address + string + + + l2gatewayserviceuuid + this L2 gateway service Uuid + string + + + l3gatewayserviceuuid + this L3 gateway service Uuid + string + + + niciradevicename + device name + string + + + nvpdeviceid + device id of the Nicire Nvp + string + + + physicalnetworkid + the physical network to which this Nirica Nvp belongs to + string + + + provider + name of the provider + string + + + transportzoneuuid + the transport zone Uuid + string + + + false + + + listAlerts + Lists all alerts. + false + + + id + the ID of the alert + false + uuid + + + keyword + List by keyword + false + string + + + name + list by alert name + false + 4.3 + string + + + page + false + integer + + + pagesize + false + integer + + + type + list by alert type + false + string + + + + + id + the id of the alert + string + + + description + description of the alert + string + + + name + the name of the alert + 4.3 + string + + + sent + the date and time the alert was sent + date + + + type + One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29 + short + + + false + + + deployVirtualMachine + Creates and automatically starts a virtual machine based on a service offering, disk offering, and template. + true + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter + false + list + list + + + bootintosetup + Boot into hardware setup or not (ignored if startVm = false, only valid for vmware) + false + 4.15.0.0 + boolean + + + bootmode + Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + boottype + Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + clusterid + destination Cluster ID to deploy the VM to - parameter available for root admin only + false + 4.13 + uuid + + + copyimagetags + if true the image tags (if any) will be copied to the VM, default value is false + false + 4.13 + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter + false + map + 4.11 + map + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + details + used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details + false + map + 4.3 + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + diskofferingid + the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created. + false + uuid + + + displayname + an optional user generated name for the virtual machine + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + 4.2 + boolean + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable + false + 4.16 + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + an optional group for the virtual machine + false + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + uuid + + + hypervisor + the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call + false + string + + + iodriverpolicy + Controls specific policies on IO + false + string + + + iothreadsenabled + IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs. + false + boolean + + + ip6address + the ipv6 address for default vm's network + false + string + + + ipaddress + the ip address for default vm's network + false + string + + + iptonetworklist + ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid + false + map + map + + + keyboard + an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us + false + string + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs used to login to the virtual machine + false + list + 4.17 + list + + + macaddress + the mac address for default vm's network + false + string + + + name + host name for the virtual machine + false + string + + + networkids + list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter + false + list + list + + + nicnetworklist + VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid + false + map + 4.15 + map + + + overridediskofferingid + the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id + false + 4.17 + uuid + + + podid + destination Pod ID to deploy the VM to - parameter available for root admin only + false + 4.13 + uuid + + + projectid + Deploy vm for the project + false + uuid + + + properties + used to specify the vApp properties. + false + map + 4.15 + map + + + rootdisksize + Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.4 + long + + + securitygroupids + comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + size + the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId + false + long + + + startvm + true if start vm after creating; defaulted to true if not specified + false + boolean + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding. + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the Userdata + false + 4.18 + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + upgradeRouterTemplate + Upgrades router to use newer template + false + + + account + upgrades all routers owned by the specified account + false + string + + + clusterid + upgrades all routers within the specified cluster + false + uuid + + + domainid + upgrades all routers owned by the specified domain + false + uuid + + + id + upgrades router with the specified Id + false + uuid + + + podid + upgrades all routers within the specified pod + false + uuid + + + zoneid + upgrades all routers within the specified zone + false + uuid + + + + + jobid + the UUID of the latest async job acting on this object + string + + + jobstatus + the current status of the latest async job acting on this object + integer + + + false + + + extractVolume + Extracts volume + true + + + id + the ID of the volume + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + zoneid + the ID of the zone where the volume is located + true + uuid + + + url + the url to which the volume would be extracted + false + string + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + updateZone + Updates a Zone. + false + + + id + the ID of the Zone + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + details + the details for the Zone + false + map + map + + + dhcpprovider + the dhcp Provider for the Zone + false + string + + + dns1 + the first DNS for the Zone + false + string + + + dns2 + the second DNS for the Zone + false + string + + + dnssearchorder + the dns search order list + false + list + list + + + domain + Network domain name for the networks in the zone; empty string will update domain with NULL value + false + string + + + guestcidraddress + the guest CIDR address for the Zone + false + string + + + internaldns1 + the first internal DNS for the Zone + false + string + + + internaldns2 + the second internal DNS for the Zone + false + string + + + ip6dns1 + the first DNS for IPv6 network in the Zone + false + string + + + ip6dns2 + the second DNS for IPv6 network in the Zone + false + string + + + ispublic + updates a private zone to public if set, but not vice-versa + false + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + false + boolean + + + name + the name of the Zone + false + string + + + sortkey + sort key of the zone, integer + false + integer + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listVlanIpRanges + Lists all VLAN IP ranges. + false + + + account + the account with which the VLAN IP range is associated. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain. + false + uuid + + + forvirtualnetwork + true if VLAN is of Virtual type, false if Direct + false + boolean + + + id + the ID of the VLAN IP range + false + uuid + + + keyword + List by keyword + false + string + + + networkid + network id of the VLAN IP range + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + physical network id of the VLAN IP range + false + uuid + + + podid + the Pod ID of the VLAN IP range + false + uuid + + + projectid + project who will own the VLAN + false + uuid + + + vlan + the ID or VID of the VLAN. Default is an "untagged" VLAN. + false + string + + + zoneid + the Zone ID of the VLAN IP range + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + cancelHostMaintenance + Cancels host maintenance. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + hypervisortype + + + hypervisorversion + the hypervisor version + string + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listProjectAccounts + Lists project's accounts + false + 3.0.0 + + + projectid + ID of the project + true + uuid + + + account + list accounts of the project by account name + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectroleid + list accounts of the project by project role id + false + uuid + + + role + list accounts of the project by role + false + string + + + userid + list invitation by user ID + false + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateAutoScalePolicy + Updates an existing autoscale policy. + true + + + id + the ID of the autoscale policy + true + uuid + + + conditionids + the list of IDs of the conditions that are being evaluated on every interval + false + list + list + + + duration + the duration in which the conditions have to be true before action is taken + false + integer + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + quiettime + the cool down period in which the policy should not be evaluated after the action has been taken + false + integer + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + createDiskOffering + Creates a disk offering. + false + + + displaytext + alternate display text of the disk offering + true + string + + + name + name of the disk offering + true + string + + + bytesreadrate + bytes read rate of the disk offering + false + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + long + + + byteswriterate + bytes write rate of the disk offering + false + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + long + + + cachemode + the cache mode to use for this disk offering. none, writeback or writethrough + false + 4.14 + string + + + customized + whether disk offering size is custom or not + false + boolean + + + customizediops + whether disk offering iops is custom or not + false + boolean + + + details + details to specify disk offering parameters + false + map + 4.16 + map + + + disksize + size of the disk offering in GB (1GB = 1,073,741,824 bytes) + false + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + false + 4.17 + boolean + + + displayoffering + an optional field, whether to display the offering to the end user or not. + false + boolean + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + encrypt + Volumes using this offering should be encrypted + false + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + false + integer + + + iopsreadrate + io requests read rate of the disk offering + false + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + long + + + iopswriterate + io requests write rate of the disk offering + false + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + long + + + maxiops + max iops of the disk offering + false + long + + + miniops + min iops of the disk offering + false + long + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + false + string + + + storagepolicy + Name of the storage policy defined at vCenter, this is applicable only for VMware + false + 4.15 + uuid + + + storagetype + the storage type of the disk offering. Values are local and shared. + false + string + + + tags + tags for the disk offering + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + storagetype + the storage type for this disk offering + string + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + listVolumes + Lists all volumes. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster id the disk volume belongs to + false + uuid + + + diskofferingid + list volumes by disk offering + false + 4.4 + uuid + + + displayvolume + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hostid + list volumes on specified host + false + uuid + + + id + the ID of the disk volume + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id + false + list + 4.9 + list + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + listsystemvms + list system VMs; only ROOT admin is eligible to pass this parameter + false + 4.18 + boolean + + + name + the name of the disk volume + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod id the disk volume belongs to + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged. + false + string + + + storageid + the ID of the storage pool, available to ROOT admin only + false + 4.3 + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + type + the type of disk volume + false + string + + + virtualmachineid + the ID of the virtual machine + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createLBHealthCheckPolicy + Creates a load balancer health check policy + true + 4.2.0 + + + lbruleid + the ID of the load balancer rule + true + uuid + + + description + the description of the load balancer health check policy + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + healthythreshold + Number of consecutive health check success before declaring an instance healthy + false + integer + + + intervaltime + Amount of time between health checks (1 sec - 20940 sec) + false + integer + + + pingpath + HTTP ping path + false + string + + + responsetimeout + Time to wait when receiving a response from the health check (2sec - 60 sec) + false + integer + + + unhealthythreshold + Number of consecutive health check failures before declaring an instance unhealthy + false + integer + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + lockUser + Locks a user account + false + + + id + Locks user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + cloudianIsEnabled + Checks if the Cloudian Connector is enabled + false + 4.11.0 + + + + enabled + the Cloudian connector enabled state + boolean + + + url + the Cloudian Management Console base URL + string + + + false + + + createNetwork + Creates a network + false + + + name + the name of the network + true + string + + + networkofferingid + the network offering ID + true + uuid + + + zoneid + the zone ID for the network + true + uuid + + + account + account that will own the network + false + string + + + aclid + Network ACL ID associated for the network + false + uuid + + + acltype + Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network + false + string + + + associatednetworkid + The network this network is associated to. only available if create a Shared network + false + 4.17.0 + uuid + + + bypassvlanoverlapcheck + when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks + false + boolean + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + false + boolean + + + displaytext + the display text of the network + false + string + + + dns1 + the first IPv4 DNS for the network + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the network + false + 4.18.0 + string + + + domainid + domain ID of the account owning a network + false + uuid + + + endip + the ending IP address in the network IP range. If not specified, will be defaulted to startIP + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + externalid + ID of the network in an external system. + false + string + + + gateway + the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC + false + string + + + hideipaddressusage + when true ip address usage for the network will not be exported by the listUsageRecords API + false + boolean + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6dns1 + the first IPv6 DNS for the network + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + false + 4.18.0 + string + + + ip6gateway + the gateway of the IPv6 network. Required for Shared networks + false + string + + + isolatedpvlan + the isolated private VLAN for this network + false + string + + + isolatedpvlantype + the isolated private VLAN type for this network + false + string + + + netmask + the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC + false + string + + + networkdomain + network domain + false + string + + + physicalnetworkid + the physical network ID the network belongs to + false + uuid + + + privatemtu + MTU to be configured on the network VR's private interface(s) + false + 4.18.0 + integer + + + projectid + an optional project for the network + false + uuid + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + routerip + IPV4 address to be assigned to a router in a shared network + false + 4.16 + string + + + routeripv6 + IPV6 address to be assigned to a router in a shared network + false + 4.16 + string + + + startip + the beginning IP address in the network IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + subdomainaccess + Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified + false + boolean + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + false + string + + + vlan + the ID or VID of the network + false + string + + + vpcid + the VPC network belongs to + false + uuid + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listNetworkOfferings + Lists all available network offerings. + false + + + availability + the availability of network offering. Default value is required + false + string + + + displaytext + list network offerings by display text + false + string + + + domainid + list network offerings available for network creation in specific domain + false + 4.13 + uuid + + + forvpc + the network offering can be used only for network creation inside the VPC + false + boolean + + + guestiptype + list network offerings by guest type: shared or isolated + false + string + + + id + list network offerings by ID + false + uuid + + + isdefault + true if need to list only default network offerings. Default value is false + false + boolean + + + istagged + true if offering has tags specified + false + boolean + + + keyword + List by keyword + false + string + + + name + list network offerings by name + false + string + + + networkid + the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to. + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + sourcenatsupported + true if need to list only netwok offerings where source NAT is supported, false otherwise + false + boolean + + + specifyipranges + true if need to list only network offerings which support specifying ip ranges + false + boolean + + + specifyvlan + the tags for the network offering. + false + boolean + + + state + list network offerings by state + false + string + + + supportedservices + list network offerings supporting certain services + false + list + list + + + tags + list network offerings by tags + false + string + + + traffictype + list by traffic type + false + string + + + zoneid + list network offerings available for network creation in specific zone + false + uuid + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + listLBHealthCheckPolicies + Lists load balancer health check policies. + false + 4.2.0 + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the health check policy + false + 4.4 + uuid + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the load balancer rule + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + listDedicatedPods + Lists dedicated pods. + false + + + account + the name of the account associated with the pod. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated pods by affinity group + false + uuid + + + domainid + the ID of the domain associated with the pod + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the ID of the pod + false + uuid + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Pod is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the pod + string + + + domainid + the domain ID to which the Pod is dedicated + string + + + podid + the ID of the Pod + string + + + podname + the Name of the Pod + string + + + false + + + listVPCs + Lists VPCs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + cidr + list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR + false + string + + + displaytext + List by display text of the VPC + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + list VPC by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list by name of the VPC + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + restartrequired + list VPCs by restartRequired option + false + boolean + + + showicon + flag to display the resource icon for VPCs + false + boolean + + + state + list VPCs by state + false + string + + + supportedservices + list VPC supporting certain services + false + list + list + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vpcofferingid + list by ID of the VPC offering + false + uuid + + + zoneid + list by zone + false + uuid + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + migrateVirtualMachineWithVolume + Attempts Migration of a VM with its volumes to a different host + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + hostid + Destination Host ID to migrate VM to. + false + uuid + + + migrateto + Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=<uuid>&migrateto[volume-index].pool=<uuid>Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume=<uuid> indicates the UUID of the volume that you want to migrate, and pool=<uuid> indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc> + false + map + map + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addNetworkDevice + Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer + false + + + networkdeviceparameterlist + parameters for network device + false + map + map + + + networkdevicetype + Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall + false + string + + + + + id + the ID of the network device + string + + + false + + + runDiagnostics + Execute network-utility command (ping/arping/tracert) on system VMs remotely + true + 4.12.0.0 + + + ipaddress + The IP/Domain address to test connection to + true + string + + + targetid + The ID of the system VM instance to diagnose + true + uuid + + + type + The system VM diagnostics type valid options are: ping, traceroute, arping + true + string + + + params + Additional command line options that apply for each command + false + string + + + + + exitcode + the command execution return code + string + + + stderr + the standard error output from the command execution + string + + + stdout + the standard output from the command execution + string + + + false + + + updateUser + Updates a user account + false + + + id + User uuid + true + uuid + + + currentpassword + Current password that was being used by the user. You must inform the current password when updating the password. + false + string + + + email + email + false + string + + + firstname + first name + false + string + + + lastname + last name + false + string + + + mandate2fa + Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA + false + 4.18.0.0 + boolean + + + password + Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port + false + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userapikey + The API key for the user. Must be specified with userSecretKey + false + string + + + username + Unique username + false + string + + + usersecretkey + The secret key for the user. Must be specified with userApiKey + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + restartVPC + Restarts a VPC + true + + + id + the id of the VPC + true + uuid + + + cleanup + If cleanup old network elements + false + boolean + + + livepatch + Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false. + false + 4.17.0 + boolean + + + makeredundant + Turn a single VPC into a redundant one. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + removeCertFromLoadBalancer + Removes a certificate from a load balancer rule + true + + + lbruleid + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + attachVolume + Attaches a disk volume to a virtual machine. + true + + + id + the ID of the disk volume + true + uuid + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + deviceid + The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.<br>When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:<ul><li>0 maps to /dev/xvda;</li><li>1 maps to /dev/xvdb;</li><li>2 maps /dev/xvdc and so on.</li></ul>Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure. + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addHost + Adds a new host. + false + + + hypervisor + hypervisor type of the host + true + string + + + podid + the Pod ID for the host + true + uuid + + + url + the host URL + true + string + + + zoneid + the Zone ID for the host + true + uuid + + + allocationstate + Allocation state of this Host for allocation of new resources + false + string + + + clusterid + the cluster ID for the host + false + uuid + + + clustername + the cluster name for the host + false + string + + + hosttags + list of tags to be added to the host + false + list + list + + + password + the password for the host; required to be passed for hypervisors other than VMWare + false + string + + + username + the username for the host; required to be passed for hypervisors other than VMWare + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + hypervisortype + + + hypervisorversion + the hypervisor version + string + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteTungstenFabricApplicationPolicySet + delete Tungsten-Fabric application policy set + true + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addBaremetalDhcp + adds a baremetal dhcp server + true + + + dhcpservertype + Type of dhcp device + true + string + + + password + Credentials to reach external dhcp device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the external dhcp appliance. + true + string + + + username + Credentials to reach external dhcp device + true + string + + + + + id + device id of + string + + + dhcpservertype + name of the provider + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + addTrafficMonitor + Adds Traffic Monitor Host for Direct Network Usage + false + + + url + URL of the traffic monitor Host + true + string + + + zoneid + Zone in which to add the external firewall appliance. + true + uuid + + + excludezones + Traffic going into the listed zones will not be metered + false + string + + + includezones + Traffic going into the listed zones will be metered + false + string + + + + + id + the ID of the external firewall + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + listLoadBalancers + Lists internal load balancers + false + 4.2.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the load balancer + false + string + + + networkid + the network ID of the load balancer + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + scheme + the scheme of the load balancer. Supported value is internal in the current release + false + string + + + sourceipaddress + the source IP address of the load balancer + false + string + + + sourceipaddressnetworkid + the network ID of the source IP address + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateProject + Updates a project + true + 3.0.0 + + + id + id of the project to be modified + true + uuid + + + account + new Admin account for the project + false + string + + + displaytext + display text of the project + false + string + + + roletype + Account level role to be assigned to the user/account : Admin/Regular + false + string + + + swapowner + when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true + false + boolean + + + userid + ID of the user to be promoted/demoted + false + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteLBStickinessPolicy + Deletes a load balancer stickiness policy. + true + 3.0.0 + + + id + the ID of the LB stickiness policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUsers + Lists user accounts + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accounttype + List users by account type. Valid types include admin, domain-admin, read-only-admin, or user. + false + integer + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + List user by ID. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for users + false + boolean + + + state + List users by state of the user account. + false + string + + + username + List user by the username + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + registerUserKeys + This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user + false + + + id + User id + true + uuid + + + + + apikey + the api key of the registered user + string + + + secretkey + the secret key of the registered user + string + + + false + + + updateVlanIpRange + Updates a VLAN IP range. + false + 4.16.0 + + + id + the UUID of the VLAN IP range + true + uuid + + + endip + the ending IP address in the VLAN IP range + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + forsystemvms + true if IP range is set to system vms, false if not + false + boolean + + + gateway + the gateway of the VLAN IP range + false + string + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6gateway + the gateway of the IPv6 network + false + string + + + netmask + the netmask of the VLAN IP range + false + string + + + startip + the beginning IP address in the VLAN IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + listVpnConnections + Lists site to site vpn connection gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + id of the vpn connection + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + id of vpc + false + uuid + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + listResourceLimits + Lists resource limits. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + Lists resource limits by ID. + false + long + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourcetype + Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + integer + + + resourcetypename + Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + string + + + + + account + the account of the resource limit + string + + + domain + the domain name of the resource limit + string + + + domainid + the domain ID of the resource limit + string + + + max + the maximum number of the resource. A -1 means the resource currently has no limit. + long + + + project + the project name of the resource limit + string + + + projectid + the project id of the resource limit + string + + + resourcetype + 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. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + false + + + disableUser + Disables a user account + true + + + id + Disables user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + removeTungstenFabricPolicy + remove Tungsten-Fabric policy + true + + + networkuuid + the uuid of Tungsten-Fabric network + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listIsos + Lists all available ISO files. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + bootable + true if the ISO is bootable, false otherwise + false + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + list ISO by ID + false + uuid + + + isofilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + false + string + + + ispublic + true if the ISO is publicly available to all users, false otherwise. + false + boolean + + + isready + true if this ISO is ready to be deployed + false + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list all ISOs by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the isos + false + boolean + + + showremoved + show removed ISOs as well + false + boolean + + + showunique + If set to true, list only unique isos across zones + false + 4.13.2 + boolean + + + tags + List resources by tags (key/value pairs) + false + map + map + + + zoneid + the ID of the zone + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateCloudToUseObjectStore + Migrate current NFS secondary storages to use object store. + false + 4.3.0 + + + provider + the image store provider name + true + string + + + details + the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + name + the name for the image store + false + string + + + url + the URL for the image store + false + string + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + listAutoScalePolicies + Lists autoscale policies. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + false + string + + + conditionid + the ID of the condition of the policy + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the autoscale policy + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vmgroupid + the ID of the autoscale vm group + false + uuid + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + addBaremetalRct + adds baremetal rack configuration text + true + + + baremetalrcturl + http url to baremetal RCT configuration + true + object + + + + + id + id of rct + string + + + url + url + string + + + false + + + addTungstenFabricNetworkGatewayToLogicalRouter + add Tungsten-Fabric network gateway to logical router + true + + + logicalrouteruuid + Tungsten-Fabric logical router uuid + true + string + + + networkuuid + Tungsten-Fabric network uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateRole + Updates a role + false + 4.9.0 + + + id + ID of the role + true + uuid + + + description + The description of the role + false + string + + + description + The description of the role + false + string + + + name + creates a role with this unique name + false + string + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + listTungstenFabricNic + list Tungsten-Fabric nic + false + + + keyword + List by keyword + false + string + + + nicuuid + the uuid of Tungsten-Fabric nic + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric nic name + string + + + uuid + Tungsten-Fabric nic uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + applyTungstenFabricPolicy + apply Tungsten-Fabric policy + true + + + majorsequence + the major sequence of Tungsten-Fabric policy + true + integer + + + minorsequence + the minor sequence of Tungsten-Fabric policy + true + integer + + + networkuuid + the uuid of network + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listVmwareDcs + Retrieves VMware DC(s) associated with a zone. + false + + + zoneid + Id of the CloudStack zone. + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + listZones + Lists zones + false + + + available + true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false. + false + boolean + + + domainid + the ID of the domain associated with the zone + false + uuid + + + id + the ID of the zone + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the zone + false + string + + + networktype + the network type of the zone that the virtual machine belongs to + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the zones + false + boolean + + + showicon + flag to display the resource image for the zones + false + boolean + + + tags + List zones by resource tags (key/value pairs) + false + map + 4.3 + map + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listRemoteAccessVpns + Lists remote access vpns + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists remote access vpn rule with the specified ID + false + 4.3 + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list remote access VPNs for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + publicipid + public ip address id of the vpn server + false + uuid + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + deleteNetworkACLList + Deletes a network ACL + true + + + id + the ID of the network ACL + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteBackupSchedule + Deletes the backup schedule of a VM + false + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createServiceInstance + Creates a system virtual-machine that implements network services + true + + + leftnetworkid + The left (inside) network for service instance + true + uuid + + + name + The name of the service instance + true + string + + + rightnetworkid + The right (outside) network ID for the service instance + true + uuid + + + serviceofferingid + The service offering ID that defines the resources consumed by the service appliance + true + uuid + + + templateid + The template ID that specifies the image for the service appliance + true + uuid + + + zoneid + Availability zone for the service instance + true + uuid + + + account + An optional account for the virtual machine. Must be used with domainId. + false + string + + + domainid + An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + Project ID for the service instance + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + name + the name of the virtual machine + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + false + + + removeIpFromNic + Removes secondary IP from the NIC. + true + + + id + the ID of the secondary ip address to nic + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBackupProviderOfferings + Lists external backup offerings of the provider + false + 4.14.0 + + + zoneid + The zone ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + releasePublicIpRange + Releases a Public IP range back to the system pool + false + + + id + the id of the Public IP range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetscalerLoadBalancerNetworks + lists network that are using a netscaler load balancer device + false + + + lbdeviceid + netscaler load balancer device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createTungstenFabricPublicNetwork + create Tungsten-Fabric public network + false + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + startSystemVm + Starts a system virtual machine. + true + + + id + The ID of the system virtual machine + true + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + listNetworkIsolationMethods + Lists supported methods of network isolation + false + 4.2.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + Network isolation method name + string + + + false + + + listHostHAResources + Lists host HA resources + false + 4.11 + + + hostid + List by host ID + false + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + listVirtualMachinesUsageHistory + Lists VM stats + false + 4.17 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the virtual machine. + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + name + the name of the virtual machine + string + + + stats + the list of VM stats + list + + + false + + + listTungstenFabricFirewallPolicy + list Tungsten-Fabric firewall policy + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + firewallrule + list Tungsten-Fabric firewall rule + list + + + name + Tungsten-Fabric firewall policy name + string + + + uuid + Tungsten-Fabric firewall policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createKubernetesCluster + Creates a Kubernetes cluster + true + + + description + description for the Kubernetes cluster + true + string + + + kubernetesversionid + Kubernetes version with which cluster to be launched + true + uuid + + + name + name for the Kubernetes cluster + true + string + + + serviceofferingid + the ID of the service offering for the virtual machines in the cluster. + true + uuid + + + size + number of Kubernetes cluster worker nodes + true + long + + + zoneid + availability zone in which Kubernetes cluster to be launched + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + controlnodes + number of Kubernetes cluster control nodes, default is 1 + false + long + + + dockerregistrypassword + password for the docker image private registry + false + string + + + dockerregistryurl + URL for the docker image private registry + false + string + + + dockerregistryusername + user name for the docker image private registry + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + externalloadbalanceripaddress + external load balancer IP address while using shared network with Kubernetes HA cluster + false + string + + + keypair + name of the ssh key pair used to login to the virtual machines + false + string + + + masternodes + number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter. + false + long + + + networkid + Network in which Kubernetes cluster is to be launched + false + uuid + + + noderootdisksize + root disk size in GB for each node + false + long + + + projectid + Deploy cluster for the project + false + uuid + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + declareHostAsDegraded + Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host. + true + 4.16.0.0 + + + id + host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + hypervisortype + + + hypervisorversion + the hypervisor version + string + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listStorageNetworkIpRange + List a storage network IP range. + false + 3.0.0 + + + id + optional parameter. Storaget network IP range uuid, if specicied, using it to search the range. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range. + false + uuid + + + zoneid + optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range. + false + uuid + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + importBackupOffering + Imports a backup offering using a backup provider + true + 4.14.0 + + + allowuserdrivenbackups + Whether users are allowed to create adhoc backups and backup schedules + true + boolean + + + description + the description of the backup offering + true + string + + + externalid + The backup offering ID (from backup provider side) + true + string + + + name + the name of the backup offering + true + string + + + zoneid + The zone ID + true + uuid + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + enableHAForHost + Enables HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + configureVirtualRouterElement + Configures a virtual router element. + true + + + id + the ID of the virtual router provider + true + uuid + + + enabled + Enabled/Disabled the service provider + true + boolean + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + deleteDomain + Deletes a specified domain + true + + + id + ID of domain to delete + true + uuid + + + cleanup + true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateVolume + Migrate volume + true + 3.0.0 + + + storageid + destination storage pool ID to migrate the volume to + true + uuid + + + volumeid + the ID of the volume + true + uuid + + + livemigrate + if the volume should be live migrated when it is attached to a running vm + false + boolean + + + newdiskofferingid + The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to. + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTungstenFabricApplicationPolicySet + create Tungsten-Fabric application policy set + true + + + name + Tungsten-Fabric application policy set name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + firewallpolicy + list Tungsten-Fabric firewall policy + list + + + name + Tungsten-Fabric policy name + string + + + tag + list Tungsten-Fabric tag + list + + + uuid + Tungsten-Fabric application policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + registerNetscalerServicePackage + Registers NCC Service Package + false + + + description + Description of Service Package + true + string + + + name + Name of the service Package. + true + string + + + + + id + Service Package UUID + string + + + description + Description of Service Package + string + + + name + Service Package Name + string + + + false + + + listHostHAProviders + Lists HA providers + false + 4.11 + + + hypervisor + Hypervisor type of the resource + true + string + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + updateVMAffinityGroup + Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. + true + + + id + The ID of the virtual machine + true + uuid + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listEvents + A command to list events. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + duration + the duration of the event + false + integer + + + enddate + the end date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss") + false + date + + + entrytime + the time the event was entered + false + integer + + + id + the ID of the event + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + level + the event level (INFO, WARN, ERROR) + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + the ID of the resource associated with the event + false + 4.17.0 + string + + + resourcetype + the type of the resource associated with the event + false + 4.17.0 + string + + + startdate + the start date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss") + false + date + + + startid + the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event + false + uuid + + + type + the event type (see event types) + false + string + + + + + id + the ID of the event + string + + + account + the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group) + string + + + created + the date the event was created + date + + + description + a brief description of the event + string + + + domain + the name of the account's domain + string + + + domainid + the id of the account's domain + string + + + level + the event level (INFO, WARN, ERROR) + string + + + parentid + whether the event is parented + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + resourceid + the id of the resource + 4.17.0 + string + + + resourcename + the name of the resource + 4.17.0 + string + + + resourcetype + the type of the resource + 4.17.0 + string + + + state + the state of the event + state + + + type + the type of the event (see event types) + string + + + username + the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine) + string + + + false + + + quotaCredits + Add +-credits to an account + false + 4.7.0 + + + account + Account Id for which quota credits need to be added + true + string + + + domainid + Domain for which quota credits need to be added + true + uuid + + + value + Value of the credits to be added+, subtracted- + true + double + + + min_balance + Minimum balance threshold of the account + false + double + + + quota_enforce + Account for which quota enforce is set to false will not be locked when there is no credit balance + false + boolean + + + + + credits + the credit deposited + bigdecimal + + + currency + currency + string + + + updated_by + the user name of the admin who updated the credits + string + + + updated_on + the account name of the admin who updated the credits + date + + + false + + + createTags + Creates resource tag(s) + true + 4.0.0 + + + resourceids + list of resources to create the tags for + true + list + list + + + resourcetype + type of the resource + true + string + + + tags + Map of tags (key/value pairs) + true + map + map + + + customer + identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createInternalLoadBalancerElement + Create an Internal Load Balancer element. + true + 4.2.0 + + + nspid + the network service provider ID of the internal load balancer element + true + uuid + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + listCaCertificate + Lists the CA public certificate(s) as support by the configured/provided CA plugin + false + 4.11.0 + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + cacertificates + The CA certificate(s) + string + + + certificate + The client certificate + string + + + privatekey + Private key for the certificate + string + + + false + + + resetApiLimit + Reset api count + false + + + account + the ID of the acount whose limit to be reset + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVlanIpRange + Creates a VLAN IP range. + false + + + id + the id of the VLAN IP range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + provisionTemplateDirectDownloadCertificate + Provisions a host with a direct download certificate + false + 4.17.0 + + + id + the id of the direct download certificate to provision + true + uuid + + + hostid + the host to provision the certificate + true + uuid + + + + + details + indicates the details in case of failure or host skipped + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + status + indicates if the certificate has been revoked from the host, failed or skipped + string + + + false + + + samlSlo + SAML Global Log Out API + false + + + + description + Response description + string + + + false + + + updateProjectRole + Creates a Project role + false + 4.15.0 + + + id + ID of the Project role + true + uuid + + + projectid + ID of project where role is being created + true + uuid + + + description + The description of the Project role + false + string + + + name + creates a project role with this unique name + false + string + + + + + projectid + the id of the project + string + + + false + + + addLdapConfiguration + Add a new Ldap Configuration + false + 4.2.0 + + + hostname + Hostname + true + string + + + port + Port + true + integer + + + domainid + linked domain + false + uuid + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port teh ldap server is running on + int + + + false + + + generateAlert + Generates an alert + true + 4.3 + + + description + Alert description + true + string + + + name + Name of the alert + true + string + + + type + Type of the alert + true + short + + + podid + Pod id for which alert is generated + false + uuid + + + zoneid + Zone id for which alert is generated + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + ldapConfig + (Deprecated, use addLdapConfiguration) Configure the LDAP context for this site. + false + 3.0.0 + + + binddn + Specify the distinguished name of a user with the search permission on the directory. + false + string + + + bindpass + Enter the password. + false + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + false + string + + + listall + If true return current LDAP configuration + false + boolean + + + port + Specify the LDAP port if required, default is 389. + false + integer + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain. + false + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com. + false + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL. + false + boolean + + + truststore + Enter the path to trust certificates store. + false + string + + + truststorepass + Enter the password for trust store. + false + string + + + + + binddn + Specify the distinguished name of a user with the search permission on the directory + string + + + bindpass + DN password + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + string + + + port + Specify the LDAP port if required, default is 389 + string + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL + string + + + true + + + listVsphereStoragePolicies + List vSphere storage policies + false + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the Storage Policy + string + + + description + the description of the Storage Policy + string + + + name + the name of the Storage Policy + string + + + policyid + the identifier of the Storage Policy in vSphere DataCenter + string + + + zoneid + the ID of the Zone + string + + + false + + + migrateVPC + moves a vpc to another physical network + true + 4.11.0 + + + vpcid + the ID of the vpc + true + uuid + + + vpcofferingid + vpc offering ID + true + uuid + + + resume + true if previous network migration cmd failed + false + boolean + + + tiernetworkofferings + network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2 + false + map + map + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deletePortForwardingRule + Deletes a port forwarding rule + true + + + id + the ID of the port forwarding rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteGlobalLoadBalancerRule + Deletes a global load balancer rule. + true + + + id + the ID of the global load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricAddressGroup + create Tungsten-Fabric address group + true + + + ipprefix + Tungsten-Fabric ip prefix + true + string + + + ipprefixlen + Tungsten-Fabric ip prefix length + true + integer + + + name + Tungsten-Fabric address group name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + ipprefix + Tungsten-Fabric address group ip prefix + string + + + ipprefixlen + Tungsten-Fabric address group ip prefix length + int + + + name + Tungsten-Fabric address group name + string + + + uuid + Tungsten-Fabric address group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateAnnotationVisibility + update an annotation visibility. + false + 4.16 + + + id + the id of the annotation + true + string + + + adminsonly + the annotation is visible for admins only + true + boolean + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + listBigSwitchBcfDevices + Lists BigSwitch BCF Controller devices + false + 4.6.0 + + + bcfdeviceid + bigswitch BCF controller device ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + bcfdeviceid + device id of the BigSwitch BCF Controller + string + + + bigswitchdevicename + device name + string + + + hostname + the controller Ip address + string + + + nat + NAT support + boolean + + + password + the controller password + string + + + physicalnetworkid + the physical network to which this BigSwitch BCF segment belongs to + string + + + provider + name of the provider + string + + + username + the controller username + string + + + false + + + configureHAForHost + Configures HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + provider + HA provider + true + string + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + updateConfiguration + Updates a configuration. + false + + + name + the name of the configuration + true + string + + + accountid + the ID of the Account to update the parameter value for corresponding account + false + uuid + + + clusterid + the ID of the Cluster to update the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to update the parameter value for corresponding domain + false + uuid + + + imagestoreuuid + the ID of the Image Store to update the parameter value for corresponding image store + false + uuid + + + storageid + the ID of the Storage pool to update the parameter value for corresponding storage pool + false + uuid + + + value + the value of the configuration + false + string + + + zoneid + the ID of the Zone to update the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + listVolumesUsageHistory + Lists volume stats + false + 4.18.0 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the volume. + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the volume + string + + + name + the name of the volume + string + + + stats + the list of VM stats + list + + + false + + + dedicatePublicIpRange + Dedicates a Public IP range to an account + false + + + id + the id of the VLAN IP range + true + uuid + + + domainid + domain ID of the account owning a VLAN + true + uuid + + + account + account who will own the VLAN + false + string + + + projectid + project who will own the VLAN + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + createProjectRolePermission + Adds API permissions to a project role + false + 4.15.0 + + + permission + The rule permission, allow or deny. Default: deny. + true + string + + + projectid + ID of project where project role permission is to be created + true + uuid + + + projectroleid + ID of the project role + true + uuid + + + rule + The API name or wildcard rule such as list* + true + string + + + description + The description of the role permission + false + string + + + + + id + the ID of the project role permission + string + + + projectid + the ID of the project + string + + + projectroleid + the ID of the project role to which the role permission belongs + string + + + projectrolename + the name of the project role to which the role permission belongs + string + + + false + + + listRegisteredServicePackages + lists registered service packages + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + Service Package UUID + string + + + description + Description of Service Package + string + + + name + Service Package Name + string + + + false + + + createConsoleEndpoint + Create a console endpoint to connect to a VM console + false + 4.18.0 + + + virtualmachineid + ID of the VM + true + uuid + + + token + (optional) extra security token, valid when the extra validation is enabled + false + string + + + + + details + details in case of an error + string + + + success + true if the console endpoint is generated properly + boolean + + + url + the console url + string + + + websocket + the console websocket options + consoleendpointwebsocketresponse + + + false + + + updateProjectRolePermission + Updates a project role permission and/or order + false + 4.15.0 + + + projectid + ID of project where project role permission is to be updated + true + uuid + + + projectroleid + ID of the project role + true + uuid + + + permission + Rule permission, can be: allow or deny + false + string + + + projectrolepermissionid + Project Role permission rule id + false + uuid + + + ruleorder + The parent role permission uuid, use 0 to move this rule at the top of the list + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + enableStaticNat + Enables static NAT for given IP address + false + + + ipaddressid + the public IP address ID for which static NAT feature is being enabled + true + uuid + + + virtualmachineid + the ID of the virtual machine for enabling static NAT feature + true + uuid + + + networkid + The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case) + false + uuid + + + vmguestip + VM guest NIC secondary IP address for the port forwarding rule + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteZone + Deletes a Zone. + false + + + id + the ID of the Zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addUserToProject + Adds user to a project + true + 4.14 + + + projectid + ID of the project to add the user to + true + uuid + + + username + Name of the user to be added to the project + true + string + + + email + email ID of user to which invitation to the project is going to be sent + false + string + + + projectroleid + ID of the project role + false + uuid + + + roletype + Project role type to be assigned to the user - Admin/Regular + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteTungstenFabricFirewallPolicy + delete Tungsten-Fabric firewall policy + true + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableHAForCluster + Disables HA cluster-wide + true + 4.11 + + + clusterid + ID of the cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getUploadParamsForTemplate + upload an existing template into the CloudStack cloud. + false + 4.6.0 + + + displaytext + the display text of the template. This is usually used for display purposes. + true + string + + + format + the format for the volume/template. Possible values include QCOW2, OVA, and VHD. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the volume/template + true + string + + + zoneid + the ID of the zone the volume/template is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs. + false + map + map + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file. + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Upload volume/template for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + recoverVirtualMachine + Recovers a virtual machine. + false + + + id + The ID of the virtual machine + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + resetNetworkPermissions + Resets network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateTungstenFabricLBHealthMonitor + update Tungsten-Fabric loadbalancer health monitor + true + + + interval + loadbalancer health monitor interval + true + integer + + + lbruleid + the ID of lb rule + true + uuid + + + retry + loadbalancer health monitor retry + true + integer + + + timeout + loadbalancer health monitor timeout + true + integer + + + type + loadbalancer health monitor type + true + string + + + expectedcode + loadbalancer health monitor expected code + false + string + + + httpmethodtype + loadbalancer health monitor http method + false + string + + + urlpath + loadbalancer health monitor url path + false + string + + + + + id + the health monitor ID + long + + + expectedcode + the health monitor expected code + string + + + httpmethod + the health monitor http method + string + + + interval + the health monitor interval + int + + + lbruleid + the LB rule ID + string + + + retry + the health monitor retry + int + + + timeout + the health monitor timeout + int + + + type + the health monitor type + string + + + urlpath + the health monitor url path + string + + + uuid + the health monitor UUID + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + releaseDedicatedHost + Release the dedication for host + true + + + hostid + the ID of the host + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateProjectInvitation + Accepts or declines project invitation + true + 3.0.0 + + + projectid + id of the project to join + true + uuid + + + accept + if true, accept the invitation, decline if false. True by default + false + boolean + + + account + account that is joining the project + false + string + + + token + list invitations for specified account; this parameter has to be specified with domainId + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + revertSnapshot + This is supposed to revert a volume snapshot. This command is only supported with KVM so far + true + + + id + The ID of the snapshot + true + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateCondition + Updates a condition for VM auto scaling + true + 4.18.0 + + + id + the ID of the condition. + true + uuid + + + relationaloperator + Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE. + true + string + + + threshold + Value for which the Counter will be evaluated with the Operator selected. + true + long + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listRegions + Lists Regions + false + + + id + List Region by region ID. + false + integer + + + keyword + List by keyword + false + string + + + name + List Region by region name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + removeTungstenFabricTag + remove Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + networkuuid + the uuid of networks + false + list + list + + + nicuuid + the uuid of nics + false + list + list + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + vmuuid + the uuid of vms + false + list + list + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listCounters + List the counters for VM auto scaling + false + + + id + ID of the Counter. + false + uuid + + + keyword + List by keyword + false + string + + + name + Name of the counter. + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + Network provider of the counter. + false + 4.18.0 + string + + + source + Source of the counter. + false + string + + + + + id + the id of the Counter + string + + + name + Name of the counter. + string + + + provider + Provider of the counter. + string + + + source + Source of the counter. + string + + + value + Value in case of snmp or other specific counters. + string + + + zoneid + zone id of counter + string + + + false + + + configureInternalLoadBalancerElement + Configures an Internal Load Balancer element. + true + 4.2.0 + + + id + the ID of the internal lb provider + true + uuid + + + enabled + Enables/Disables the Internal Load Balancer element + true + boolean + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + migrateSystemVm + Attempts Migration of a system virtual machine to the host specified. + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default + false + 4.16.0 + boolean + + + hostid + destination Host ID to migrate VM to + false + uuid + + + storageid + Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume + false + 4.16.0 + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + listVirtualRouterElements + Lists all available virtual router elements. + false + + + enabled + list network offerings by enabled state + false + boolean + + + id + list virtual router elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list virtual router elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + deleteSnapshotPolicies + Deletes snapshot policies for the account. + false + + + id + the Id of the snapshot policy + false + uuid + + + ids + list of snapshots policy IDs separated by comma + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTrafficTypeImplementors + Lists implementors of implementor of a network traffic type or implementors of all network traffic types + false + 3.0.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + traffictype + Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor + false + string + + + + + traffictype + network traffic type + string + + + traffictypeimplementor + implementor of network traffic type + string + + + false + + + listDbMetrics + list the db hosts and statistics + false + 4.17.0 + + + + collectiontime + the time these statistics were collected + date + + + connections + the number of connections to the DB + int + + + dbloadaverages + the last measured load averages on the DB + double[] + + + hostname + the name of the active usage server + string + + + queries + the number of queries performed on the DB + long + + + replicas + the state of the usage server + string[] + + + tlsversions + the tls versions currently in use (accepted) by the DB + string + + + uptime + the uptime of the DB in seconds + long + + + version + the version of the currently running DB + string + + + versioncomment + the version of the currently running DB + string + + + false + + + linkAccountToLdap + link a cloudstack account to a group or OU in ldap + false + 4.11.0 + + + account + name of the account, it will be created if it does not exist + true + string + + + accounttype + Type of the account to auto import. Specify 0 for user and 2 for domain admin + true + integer + + + domainid + The id of the domain that is to contain the linked account. + true + uuid + + + ldapdomain + name of the group or OU in LDAP + true + string + + + admin + domain admin username in LDAP + false + string + + + type + type of the ldap name. GROUP or OU, defaults to GROUP + false + string + + + + + accountid + Domain Admin accountId that is created + string + + + accounttype + Type of the account to auto import + int + + + domainid + id of the Domain which is linked to LDAP + string + + + ldapdomain + name of the group or OU in LDAP which is linked to the domain + string + + + name + name of the group or OU in LDAP which is linked to the domain + string + + + type + type of the name in LDAP which is linke to the domain + string + + + false + + + deleteImageStore + Deletes an image store or Secondary Storage. + false + 4.2.0 + + + id + The image store ID or Secondary Storage ID. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAutoScaleVmProfiles + Lists autoscale vm profiles. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the autoscale vm profile + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + otherdeployparams + the otherdeployparameters of the autoscale vm profile + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + serviceofferingid + list profiles by service offering id + false + 4.4 + uuid + + + templateid + the templateid of the autoscale vm profile + false + uuid + + + zoneid + availability zone for the auto deployed virtual machine + false + 4.4 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base 64 encoded VM user data + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + disableOutOfBandManagementForHost + Disables out-of-band management for a host + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + authorizeSecurityGroupIngress + Authorizes a particular ingress rule for this security group + true + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + cidrlist + the cidr list associated. Multiple entries must be separated by a single comma character (,). + false + list + list + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + endport + end port for this ingress rule + false + integer + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + projectid + an optional project of the security group + false + uuid + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default. + false + string + + + securitygroupid + The ID of the security group. Mutually exclusive with securityGroupName parameter + false + uuid + + + securitygroupname + The name of the security group. Mutually exclusive with securityGroupId parameter + false + string + + + startport + start port for this ingress rule + false + integer + + + usersecuritygrouplist + user to security group mapping + false + map + map + + + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + cancelHostAsDegraded + Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'. + true + 4.16.0.0 + + + id + host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + hypervisortype + + + hypervisorversion + the hypervisor version + string + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + syncStoragePool + Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it) + true + 4.15.1 + + + id + Storage pool id + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + name + the name of the storage pool + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createSecurityGroup + Creates a security group + false + + + name + name of the security group + true + string + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + description + the description of the security group + false + string + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + Create security group for project + false + uuid + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeVirtualMachineFromBackupOffering + Removes a VM from any existing backup offering + true + 4.14.0 + + + virtualmachineid + ID of the virtual machine + true + uuid + + + forced + Whether to force remove VM from the backup offering that may also delete VM backups. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkPermissions + List network visibility and all accounts that have permissions to view this network. + false + 4.17.0 + + + networkid + Lists network permission by network ID + true + uuid + + + + + account + the account the network is available for + string + + + accountid + the ID of account the network is available for + string + + + domain + the name of the domain to which the network belongs + string + + + domainid + the ID of the domain to which the network belongs + string + + + networkid + the network ID + string + + + project + the project the network is available for + string + + + projectid + the ID of project the network is available for + string + + + false + + + updateResourceCount + Recalculate and update resource count for an account or domain. + false + + + domainid + If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain. + true + uuid + + + account + Update resource count for a specified account. Must be used with the domainId parameter. + false + string + + + projectid + Update resource limits for project + false + uuid + + + resourcetype + Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + integer + + + + + account + the account for which resource count's are updated + string + + + domain + the domain name for which resource count's are updated + string + + + domainid + the domain ID for which resource count's are updated + string + + + project + the project name for which resource count's are updated + string + + + projectid + the project id for which resource count's are updated + string + + + resourcecount + resource count + long + + + resourcetype + resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + false + + + listVpnGateways + Lists site 2 site vpn gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + id of the vpn gateway + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + id of vpc + false + uuid + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + listRoles + Lists dynamic roles in CloudStack + false + 4.9.0 + + + id + List role by role ID. + false + uuid + + + keyword + List by keyword + false + string + + + name + List role by role name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + type + List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User. + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + listTungstenFabricPolicy + list Tungsten-Fabric policy + false + + + ipaddressid + the ID of ip address + false + uuid + + + keyword + List by keyword + false + string + + + networkid + the ID of network + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + getCloudIdentifier + Retrieves a cloud identifier. + false + + + userid + the user ID for the cloud identifier + true + uuid + + + + + cloudidentifier + the cloud identifier + string + + + signature + the signed response for the cloud identifier + string + + + userid + the user ID for the cloud identifier + string + + + false + + + createLBStickinessPolicy + Creates a load balancer stickiness policy + true + 3.0.0 + + + lbruleid + the ID of the load balancer rule + true + uuid + + + methodname + name of the load balancer stickiness policy method, possible values can be obtained from listNetworks API + true + string + + + name + name of the load balancer stickiness policy + true + string + + + description + the description of the load balancer stickiness policy + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + param + param list. Example: param[0].name=cookiename&param[0].value=LBCookie + false + map + map + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + addCiscoAsa1000vResource + Adds a Cisco Asa 1000v appliance + false + + + clusterid + the Cluster ID + true + uuid + + + hostname + Hostname or ip address of the Cisco ASA 1000v appliance. + true + string + + + insideportprofile + Nexus port profile associated with inside interface of ASA 1000v + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + + false + + + configurePaloAltoFirewall + Configures a Palo Alto firewall device + true + + + fwdeviceid + Palo Alto firewall device ID + true + uuid + + + fwdevicecapacity + capacity of the firewall device, Capacity will be interpreted as number of networks device can handle + false + long + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + updateNetworkACLItem + Updates ACL item with specified ID + true + + + id + the ID of the network ACL item + true + uuid + + + action + scl entry action, allow or deny + false + string + + + cidrlist + the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + endport + the ending port of ACL + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + number + The network of the vm the ACL will be created for + false + integer + + + partialupgrade + Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'. + false + boolean + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + false + string + + + reason + A description indicating why the ACL rule is required. + false + string + + + startport + the starting port of ACL + false + integer + + + traffictype + the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + moveUser + Moves a user to another account + false + 4.11 + + + id + id of the user to be deleted + true + uuid + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + false + string + + + accountid + Creates the user under the specified domain. Has to be accompanied with the account parameter + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listRouters + List routers. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster ID of the router + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fetchhealthcheckresults + if true is passed for this parameter, also fetch last executed health check results for the router. Default is false + false + 4.14 + boolean + + + forvpc + if true is passed for this parameter, list only VPC routers + false + boolean + + + healthchecksfailed + if this parameter is passed, list only routers by health check results + false + 4.16 + boolean + + + hostid + the host ID of the router + false + uuid + + + id + the ID of the disk router + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the router + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the router + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + the state of the router + false + string + + + version + list virtual router elements by version + false + string + + + vpcid + List networks by VPC + false + uuid + + + zoneid + the Zone ID of the router + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + releaseHostReservation + Releases host reservation. + true + + + id + the host ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricVm + list Tungsten-Fabric vm + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + vmuuid + the uuid of Tungsten-Fabric vm + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric vm name + string + + + uuid + Tungsten-Fabric nic uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createVpnConnection + Create site to site vpn connection + true + + + s2scustomergatewayid + id of the customer gateway + true + uuid + + + s2svpngatewayid + id of the vpn gateway + true + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + passive + connection is passive or not + false + boolean + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + listBrocadeVcsDeviceNetworks + lists network that are using a brocade vcs switch + false + + + vcsdeviceid + brocade vcs switch ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deletePhysicalNetwork + Deletes a Physical Network. + true + 3.0.0 + + + id + the ID of the Physical network + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addTungstenFabricPolicyRule + add Tungsten-Fabric policy rule + true + + + action + Tungsten-Fabric policy rule action + true + string + + + destendport + Tungsten-Fabric policy rule destination end port + true + integer + + + destipprefix + Tungsten-Fabric policy rule destination ip prefix + true + string + + + destipprefixlen + Tungsten-Fabric policy rule destination ip prefix length + true + integer + + + destnetwork + Tungsten-Fabric policy rule destination network + true + string + + + deststartport + Tungsten-Fabric policy rule destination start port + true + integer + + + direction + Tungsten-Fabric policy rule direction + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + protocol + Tungsten-Fabric policy rule protocol + true + string + + + srcendport + Tungsten-Fabric policy rule source end port + true + integer + + + srcipprefix + Tungsten-Fabric policy rule source ip prefix + true + string + + + srcipprefixlen + Tungsten-Fabric policy rule source ip prefix length + true + integer + + + srcnetwork + Tungsten-Fabric policy rule source network + true + string + + + srcstartport + Tungsten-Fabric policy rule source start port + true + integer + + + zoneid + the ID of zone + true + uuid + + + + + action + Tungsten-Fabric policy action + string + + + destendport + Tungsten-Fabric policy destination end port + int + + + destipprefix + Tungsten-Fabric policy destination ip prefix + string + + + destipprefixlen + Tungsten-Fabric policy destination ip prefix length + int + + + destnetwork + Tungsten-Fabric policy destination network + string + + + deststartport + Tungsten-Fabric policy destination start port + int + + + direction + Tungsten-Fabric policy name + string + + + policyuuid + Tungsten-Fabric policy uuid + string + + + protocol + Tungsten-Fabric policy protocol + string + + + srcendport + Tungsten-Fabric policy source end port + int + + + srcipprefix + Tungsten-Fabric policy source ip prefix + string + + + srcipprefixlen + Tungsten-Fabric policy source ip prefix length + int + + + srcnetwork + Tungsten-Fabric policy source network + string + + + srcstartport + Tungsten-Fabric policy source start port + int + + + uuid + Tungsten-Fabric rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + dedicateHost + Dedicates a host. + true + + + domainid + the ID of the containing domain + true + uuid + + + hostid + the ID of the host to update + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the host + string + + + affinitygroupid + the Dedication Affinity Group ID of the host + string + + + domainid + the domain ID of the host + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + false + + + removeVpnUser + Removes vpn user + true + + + username + username for the vpn user + true + string + + + account + an optional account for the vpn user. Must be used with domainId. + false + string + + + domainid + an optional domainId for the vpn user. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + remove vpn user from the project + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addGloboDnsHost + Adds the GloboDNS external host + true + 4.5.0 + + + password + Password for GloboDNS + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + GloboDNS url + true + string + + + username + Username for GloboDNS + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + logout + Logs out the user + false + + + + description + Response description + string + + + false + + + deleteLBHealthCheckPolicy + Deletes a load balancer health check policy. + true + 4.2.0 + + + id + the ID of the load balancer health check policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + importRole + Imports a role based on provided map of rule permissions + false + 4.15.0 + + + name + Creates a role with this unique name + true + string + + + rules + Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing + true + map + map + + + description + The description of the role + false + string + + + forced + Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false. + false + boolean + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + disableHAForHost + Disables HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + listSwifts + List Swift. + false + 3.0.0 + + + id + the id of the swift + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + enableOutOfBandManagementForHost + Enables out-of-band management for a host + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + deleteServiceOffering + Deletes a service offering. + false + + + id + the ID of the service offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listKubernetesSupportedVersions + Lists supported Kubernetes version + false + + + id + the ID of the Kubernetes supported version + false + uuid + + + keyword + List by keyword + false + string + + + minimumkubernetesversionid + the ID of the minimum Kubernetes supported version + false + uuid + + + minimumsemanticversion + the minimum semantic version for the Kubernetes supported version to be listed + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of the zone in which Kubernetes supported version will be available + false + uuid + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + addNiciraNvpDevice + Adds a Nicira NVP device + true + + + hostname + Hostname of ip address of the Nicira NVP Controller. + true + string + + + password + Credentials to access the Nicira Controller API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + transportzoneuuid + The Transportzone UUID configured on the Nicira Controller + true + string + + + username + Credentials to access the Nicira Controller API + true + string + + + l2gatewayserviceuuid + The L2 Gateway Service UUID configured on the Nicira Controller + false + string + + + l3gatewayserviceuuid + The L3 Gateway Service UUID configured on the Nicira Controller + false + string + + + + + hostname + the controller Ip address + string + + + l2gatewayserviceuuid + this L2 gateway service Uuid + string + + + l3gatewayserviceuuid + this L3 gateway service Uuid + string + + + niciradevicename + device name + string + + + nvpdeviceid + device id of the Nicire Nvp + string + + + physicalnetworkid + the physical network to which this Nirica Nvp belongs to + string + + + provider + name of the provider + string + + + transportzoneuuid + the transport zone Uuid + string + + + false + + + quotaEmailTemplateUpdate + Updates existing email templates for quota alerts + false + 4.7.0 + + + templatebody + The quota email template body, max: 500k characters + true + string + + + templatesubject + The quota email template subject, max: 77 characters + true + string + + + templatetype + Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY + true + string + + + locale + The locale of the email text + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkServiceProviders + Lists network serviceproviders for a given physical network. + false + 3.0.0 + + + keyword + List by keyword + false + string + + + name + list providers by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + state + list providers by state + false + string + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + deleteTungstenFabricTagType + delete Tungsten-Fabric tag type + true + + + tagtypeuuid + the ID of Tungsten-Fabric tag type + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listInfrastructure + Lists infrastructure + false + 4.9.3 + + + + alerts + Number of Alerts + integer + + + clusters + Number of clusters + integer + + + cpusockets + Number of cpu sockets + integer + + + hosts + Number of hypervisor hosts + integer + + + ilbvms + Number of internal LBs + integer + + + imagestores + Number of images stores + integer + + + managementservers + Number of management servers + integer + + + pods + Number of pods + integer + + + routers + Number of routers + integer + + + storagepools + Number of storage pools + integer + + + systemvms + Number of systemvms + integer + + + zones + Number of zones + integer + + + false + + + deleteNetscalerControlCenter + Delete Netscaler Control Center + false + + + id + Netscaler Control Center ID + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUsageRecords + Lists usage records for accounts + false + + + enddate + End date range for usage record query (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00). + true + date + + + startdate + Start date range for usage record query (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00). + true + date + + + account + List usage records for the specified user. + false + string + + + accountid + List usage records for the specified account + false + uuid + + + domainid + List usage records for the specified domain. + false + uuid + + + includetags + Flag to enable display of Tags for a resource + false + boolean + + + isrecursive + Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account. + false + 4.15 + boolean + + + keyword + List by keyword + false + string + + + oldformat + Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + List usage records for specified project + false + uuid + + + type + List usage records for the specified usage type + false + long + + + usageid + List usage records for the specified usage UUID. Can be used only together with TYPE parameter. + false + string + + + + + account + the user account name + string + + + accountid + the user account Id + string + + + cpunumber + number of cpu of resource + long + + + cpuspeed + speed of each cpu of resource + long + + + description + description of the usage record + string + + + domain + the domain the resource is associated with + string + + + domainid + the domain ID + string + + + enddate + end date of the usage record + string + + + isdefault + True if the resource is default + boolean + + + issourcenat + True if the IPAddress is source NAT + boolean + + + issystem + True if the IPAddress is system IP - allocated during vm deploy or lb rule create + boolean + + + memory + memory allocated for the resource + long + + + name + resource or virtual machine name + string + + + networkid + id of the network + string + + + offeringid + offering ID + string + + + oscategoryid + virtual machine guest os category ID + string + + + oscategoryname + virtual machine os category name + string + + + osdisplayname + virtual machine os display name + string + + + ostypeid + virtual machine os type ID + string + + + project + the project name of the resource + string + + + projectid + the project id of the resource + string + + + rawusage + raw usage in hours + string + + + size + resource size + long + + + startdate + start date of the usage record + string + + + templateid + template ID + string + + + type + resource type + string + + + usage + usage in hours + string + + + usageid + id of the resource + string + + + usagetype + usage type ID + integer + + + virtualmachineid + virtual machine ID + string + + + virtualsize + virtual size of resource + long + + + vpcid + id of the vpc + string + + + zoneid + the zone ID + string + + + false + + + deleteVolume + Deletes a detached disk volume. + false + + + id + The ID of the disk volume + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + recoverVolume + Recovers a Destroy volume. + false + 4.14.0 + + + id + The ID of the volume + true + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeTungstenFabricNetworkGatewayFromLogicalRouter + remove Tungsten-Fabric network gateway from logical router + true + + + logicalrouteruuid + Tungsten-Fabric logical router uuid + true + string + + + networkuuid + Tungsten-Fabric network uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + enableUser + Enables a user account + false + + + id + Enables user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + listZonesMetrics + Lists zone metrics + false + 4.9.3 + + + available + true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false. + false + boolean + + + domainid + the ID of the domain associated with the zone + false + uuid + + + id + the ID of the zone + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the zone + false + string + + + networktype + the network type of the zone that the virtual machine belongs to + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the zones + false + boolean + + + showicon + flag to display the resource image for the zones + false + boolean + + + tags + List zones by resource tags (key/value pairs) + false + map + 4.3 + map + + + + + clusters + healthy / total clusters in the zone + string + + + cpuallocated + the total cpu allocated in Ghz + string + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpumaxdeviation + the maximum cpu deviation + string + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotal + the total cpu capacity in Ghz + string + + + cpuused + the total cpu used in Ghz + string + + + memoryallocated + the total cpu allocated in GiB + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorymaxdeviation + the maximum memory deviation + string + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotal + the total cpu capacity in GiB + string + + + memoryused + the total cpu used in GiB + string + + + state + state of the cluster + string + + + false + + + quotaTariffCreate + Creates a quota tariff for a resource. + false + 4.18.0.0 + + + name + Quota tariff's name + true + string + + + usagetype + Integer value for the usage type of the resource. + true + integer + + + value + The quota tariff value of the resource as per the default unit. + true + double + + + activationrule + Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. + false + string + + + description + Quota tariff's description. + false + string + + + enddate + The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2009-06-03. + false + date + + + startdate + The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. Inform null to use the current date. + false + date + + + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + uuid + uuid + string + + + false + + + extractTemplate + Extracts a template + true + + + id + the ID of the template + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + url + the url to which the ISO would be extracted + false + string + + + zoneid + the ID of the zone where the ISO is originally located + false + uuid + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + expungeVirtualMachine + Expunge a virtual machine. Once expunged, it cannot be recoverd. + true + + + id + The ID of the virtual machine + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + suspendProject + Suspends a project + true + 3.0.0 + + + id + id of the project to be suspended + true + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateIpAddress + Updates an IP address + true + + + id + the ID of the public IP address to update + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + 4.4 + boolean + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocatin, Allocated and Releasing + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachinename + virtual machine name the ip address is assigned to (not null only for static nat Ip) + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + getApiLimit + Get API limit count for the caller + false + + + + account + the account name of the api remaining count + string + + + accountid + the account uuid of the api remaining count + string + + + apiAllowed + currently allowed number of apis + int + + + apiIssued + number of api already issued + int + + + expireAfter + seconds left to reset counters + long + + + false + + + deleteStorageNetworkIpRange + Deletes a storage network IP Range. + true + 3.0.0 + + + id + the uuid of the storage network ip range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateNetwork + moves a network to another physical network + true + 4.11.0 + + + networkid + the ID of the network + true + uuid + + + networkofferingid + network offering ID + true + uuid + + + resume + true if previous network migration cmd failed + false + boolean + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + addVmwareDc + Adds a VMware datacenter to specified zone + false + + + name + Name of VMware datacenter to be added to specified zone. + true + string + + + vcenter + The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + true + string + + + zoneid + The Zone ID. + true + uuid + + + password + The password for specified username. + false + string + + + username + The Username required to connect to resource. + false + string + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + listUnmanagedInstances + Lists unmanaged virtual machines for a given cluster. + false + 4.14.0 + + + clusterid + the cluster ID + true + uuid + + + keyword + List by keyword + false + string + + + name + the hypervisor name of the instance + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + clusterid + the ID of the cluster to which virtual machine belongs + string + + + cpucorepersocket + the CPU cores per socket for the virtual machine. VMware specific + integer + + + cpunumber + the CPU cores of the virtual machine + integer + + + cpuspeed + the CPU speed of the virtual machine + integer + + + hostid + the ID of the host to which virtual machine belongs + string + + + hostname + the name of the host to which virtual machine belongs + string + + + memory + the memory of the virtual machine in MB + integer + + + name + the name of the virtual machine + string + + + osdisplayname + the operating system of the virtual machine + string + + + osid + the operating system ID of the virtual machine + string + + + powerstate + the power state of the virtual machine + string + + + disk(*) + the list of disks associated with the virtual machine + + + id + the ID of the disk + string + + + capacity + the capacity of the disk in bytes + long + + + controller + the controller of the disk + string + + + controllerunit + the controller unit of the disk + integer + + + datastorehost + the controller of the disk + string + + + datastorename + the controller of the disk + string + + + datastorepath + the controller of the disk + string + + + datastoretype + the controller of the disk + string + + + imagepath + the file path of the disk image + string + + + label + the label of the disk + string + + + position + the position of the disk + integer + + + set + + + nic(*) + the list of nics associated with the virtual machine + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateIpv6FirewallRule + Updates Ipv6 firewall rule with specified ID + true + + + id + the ID of the ipv6 firewall rule + true + uuid + + + cidrlist + the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + endport + the ending port of Ipv6 firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the Ipv6 firewall rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + protocol + the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + false + string + + + startport + the starting port of Ipv6 firewall rule + false + integer + + + traffictype + the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateIsoPermissions + Updates ISO permissions + false + + + id + the template ID + true + uuid + + + accounts + a comma delimited list of accounts within caller's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + isextractable + true if the template/iso is extractable, false other wise. Can be set only by root admin + false + boolean + + + isfeatured + true for featured template/iso, false otherwise + false + boolean + + + ispublic + true for public template/iso, false for private templates/isos + false + boolean + + + op + permission operator (add, remove, reset) + false + string + + + projectids + a comma delimited list of projects. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + registerTemplate + Registers an existing template into the CloudStack cloud. + false + + + displaytext + the display text of the template. This is usually used for display purposes. + true + string + + + format + the format for the template. Possible values include QCOW2, RAW, VHD and OVA. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the template + true + string + + + url + the URL of where the template is hosted. Possible URL include http:// and https:// + true + string + + + account + an optional accountName. Must be used with domainId. + false + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + directdownload + true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Register template for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + zoneid + the ID of the zone the template is to be hosted on + false + uuid + + + zoneids + A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. + false + list + list + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteVPCOffering + Deletes VPC offering + true + + + id + the ID of the VPC offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addStratosphereSsp + Adds stratosphere ssp server + false + + + name + stratosphere ssp api name + true + string + + + url + stratosphere ssp server url + true + string + + + zoneid + the zone ID + true + uuid + + + password + stratosphere ssp api password + false + string + + + tenantuuid + stratosphere ssp tenant uuid + false + string + + + username + stratosphere ssp api username + false + string + + + + + hostid + server id of the stratosphere ssp server + string + + + name + name + string + + + url + url of ssp endpoint + string + + + zoneid + zone which this ssp controls + string + + + false + + + deleteNetworkACL + Deletes a network ACL + true + + + id + the ID of the network ACL + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + findStoragePoolsForMigration + Lists storage pools available for migration of a volume. + false + + + id + the ID of the volume + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + name + the name of the storage pool + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createStoragePool + Creates a storage pool. + false + + + name + the name for the storage pool + true + string + + + url + the URL of the storage pool + true + string + + + zoneid + the Zone ID for the storage pool + true + uuid + + + capacitybytes + bytes CloudStack can provision from this storage pool + false + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + false + long + + + clusterid + the cluster ID for the storage pool + false + uuid + + + details + the details for the storage pool + false + map + map + + + hypervisor + hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now. + false + string + + + managed + whether the storage should be managed by CloudStack + false + boolean + + + podid + the Pod ID for the storage pool + false + uuid + + + provider + the storage provider name + false + string + + + scope + the scope of the storage: cluster or zone + false + string + + + tags + the tags for the storage pool + false + string + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + name + the name of the storage pool + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTungstenFabricTag + create Tungsten-Fabric tag + true + + + tagtype + Tungsten-Fabric tag type + true + string + + + tagvalue + Tungsten-Fabric tag value + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + addOpenDaylightController + Adds an OpenDyalight controler + true + + + password + Credential to access the OpenDaylight API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + Api URL of the OpenDaylight Controller. + true + string + + + username + Username to access the OpenDaylight API + true + string + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + deleteTungstenFabricFirewallRule + delete Tungsten-Fabric firewall rule + true + + + firewallruleuuid + the uuid of Tungsten-Fabric firewall rule + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createZone + Creates a Zone. + false + + + dns1 + the first DNS for the Zone + true + string + + + internaldns1 + the first internal DNS for the Zone + true + string + + + name + the name of the Zone + true + string + + + networktype + network type of the zone, can be Basic or Advanced + true + string + + + allocationstate + Allocation state of this Zone for allocation of new resources + false + string + + + dns2 + the second DNS for the Zone + false + string + + + domain + Network domain name for the networks in the zone + false + string + + + domainid + the ID of the containing domain, null for public zones + false + uuid + + + guestcidraddress + the guest CIDR address for the Zone + false + string + + + internaldns2 + the second internal DNS for the Zone + false + string + + + ip6dns1 + the first DNS for IPv6 network in the Zone + false + string + + + ip6dns2 + the second DNS for IPv6 network in the Zone + false + string + + + isedge + true if the zone is an edge zone, false otherwise + false + 4.18.0 + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + false + boolean + + + securitygroupenabled + true if network is security group enabled, false otherwise + false + boolean + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + disableCiscoNexusVSM + disable a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be deleted + true + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + createStorageNetworkIpRange + Creates a Storage network IP range. + true + 3.0.0 + + + gateway + the gateway for storage network + true + string + + + netmask + the netmask for storage network + true + string + + + podid + UUID of pod where the ip range belongs to + true + uuid + + + startip + the beginning IP address + true + string + + + endip + the ending IP address + false + string + + + vlan + Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table + false + integer + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + listDomainChildren + Lists all children domains belonging to a specified domain + false + + + id + list children domain by parent domain ID. + false + uuid + + + isrecursive + to return the entire tree, use the value "true". To return the first level children, use the value "false". + false + boolean + + + keyword + List by keyword + false + string + + + listall + 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 + false + boolean + + + name + list children domains by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for domains + false + boolean + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + getVMPassword + Returns an encrypted password for the VM + false + + + id + The ID of the virtual machine + true + uuid + + + + + encryptedpassword + The base64 encoded encrypted password of the VM + string + + + false + + + configureOvsElement + Configures an ovs element. + true + + + id + the ID of the ovs provider + true + uuid + + + enabled + Enabled/Disabled the service provider + true + boolean + + + + + id + the id of the ovs + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + assignToGlobalLoadBalancerRule + Assign load balancer rule or list of load balancer rules to a global load balancer rules. + true + + + id + the ID of the global load balancer rule + true + uuid + + + loadbalancerrulelist + the list load balancer rules that will be assigned to global load balancer rule + true + list + list + + + gslblbruleweightsmap + Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10' + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + uploadTemplateDirectDownloadCertificate + Upload a certificate for HTTPS direct template download on KVM hosts + false + 4.11.0 + + + certificate + SSL certificate + true + string + + + hypervisor + Hypervisor type + true + string + + + name + Name for the uploaded certificate + true + string + + + zoneid + Zone to upload certificate + true + uuid + + + hostid + (optional) the host ID to upload certificate + false + uuid + + + + + id + the direct download certificate id + string + + + alias + the direct download certificate alias + string + + + hostsmap + the hosts where the certificate is uploaded to + list + + + hypervisor + the hypervisor of the hosts where the certificate is uploaded + string + + + issuer + the direct download certificate issuer + string + + + serialnum + the direct download certificate serial num + string + + + subject + the direct download certificate subject + string + + + validity + the direct download certificate issuer + string + + + version + the direct download certificate version + string + + + zoneid + the zone id where the certificate is uploaded + string + + + zonename + the zone name where the certificate is uploaded + string + + + false + + + addImageStoreS3 + Adds S3 Image Store + false + 4.7.0 + + + accesskey + S3 access key + true + string + + + bucket + Name of the storage bucket + true + string + + + endpoint + S3 endpoint + true + string + + + secretkey + S3 secret key + true + string + + + connectiontimeout + Connection timeout (milliseconds) + false + integer + + + connectionttl + Connection TTL (milliseconds) + false + integer + + + maxerrorretry + Maximum number of times to retry on error + false + integer + + + s3signer + Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType + false + string + + + sockettimeout + Socket timeout (milliseconds) + false + integer + + + usehttps + Use HTTPS instead of HTTP + false + boolean + + + usetcpkeepalive + Whether TCP keep-alive is used + false + boolean + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + importUnmanagedInstance + Import unmanaged virtual machine from a given cluster. + true + 4.14.0 + + + clusterid + the cluster ID + true + uuid + + + name + the hypervisor name of the instance + true + string + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping using keys disk and diskOffering + false + map + map + + + details + used to specify the custom parameters. + false + map + map + + + displayname + the display name of the instance + false + string + + + domainid + import instance to the domain specified + false + uuid + + + forced + VM is imported despite some of its NIC's MAC addresses are already present + false + boolean + + + hostname + the host name of the instance + false + string + + + migrateallowed + vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool + false + boolean + + + nicipaddresslist + VM nic to ip address mapping using keys nic, ip4Address + false + map + map + + + nicnetworklist + VM nic to network id mapping using keys nic and network + false + map + map + + + projectid + import instance for the project + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listSystemVmsUsageHistory + Lists System VM stats + false + 4.18.0 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the system VM. + false + uuid + + + ids + the IDs of the system VMs, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + name + the name of the virtual machine + string + + + stats + the list of VM stats + list + + + false + + + deleteIpv6FirewallRule + Deletes a IPv6 firewall rule + true + + + id + the ID of the IPv6 firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createPhysicalNetwork + Creates a physical network + true + 3.0.0 + + + name + the name of the physical network + true + string + + + zoneid + the Zone ID for the physical network + true + uuid + + + broadcastdomainrange + the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic + false + string + + + domainid + domain ID of the account owning a physical network + false + uuid + + + isolationmethods + the isolation method for the physical network[VLAN/L3/GRE] + false + list + list + + + networkspeed + the speed for the physical network[1G/10G] + false + string + + + tags + Tag the physical network + false + list + list + + + vlan + the VLAN for the physical network + false + string + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + listAutoScaleVmGroups + Lists autoscale vm groups. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the autoscale vm group + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the loadbalancer + false + uuid + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + page + false + integer + + + pagesize + false + integer + + + policyid + the ID of the policy + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vmprofileid + the ID of the profile + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + createFirewallRule + Creates a firewall rule for a given IP address + true + + + ipaddressid + the IP address id of the port forwarding rule + true + uuid + + + protocol + the protocol for the firewall rule. Valid values are TCP/UDP/ICMP. + true + string + + + cidrlist + the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + startport + the starting port of firewall rule + false + integer + + + type + type of firewallrule: system/user + false + string + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createVolume + Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it. + true + + + account + the account associated with the disk volume. Must be used with the domainId parameter. + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + diskofferingid + the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in. + false + uuid + + + displayvolume + an optional field, whether to display the volume to the end user or not. + false + boolean + + + domainid + the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain. + false + uuid + + + maxiops + max iops + false + long + + + miniops + min iops + false + long + + + name + the name of the disk volume + false + string + + + projectid + the project associated with the volume. Mutually exclusive with account parameter + false + uuid + + + size + Arbitrary volume size + false + long + + + snapshotid + the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in. + false + uuid + + + virtualmachineid + the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVMSnapshot + List virtual machine snapshot by conditions + false + 4.2.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + lists snapshot by snapshot name or display name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + state of the virtual machine snapshot + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + the ID of the vm + false + uuid + + + vmsnapshotid + The ID of the VM snapshot + false + uuid + + + vmsnapshotids + the IDs of the vm snapshots, mutually exclusive with vmsnapshotid + false + list + 4.9 + list + + + + + id + the ID of the vm snapshot + string + + + account + the account associated with the disk volume + string + + + created + the create date of the vm snapshot + date + + + current + indicates if this is current snapshot + boolean + + + description + the description of the vm snapshot + string + + + displayname + the display name of the vm snapshot + string + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + hypervisor + the type of hypervisor on which snapshot is stored + hypervisortype + + + name + the name of the vm snapshot + string + + + parent + the parent ID of the vm snapshot + string + + + parentName + the parent displayName of the vm snapshot + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the vm snapshot + state + + + type + VM Snapshot type + string + + + virtualmachineid + the vm ID of the vm snapshot + string + + + virtualmachinename + the vm name of the vm snapshot + 4.15.1 + string + + + zoneid + the Zone ID of the vm snapshot + string + + + zonename + the Zone name of the vm snapshot + 4.15.1 + string + + + false + + + moveNetworkAclItem + Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list + true + + + id + The ID of the network ACL rule that is being moved to a new position. + true + string + + + aclconsistencyhash + Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field). + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + nextaclruleid + The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list. + false + string + + + previousaclruleid + The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list. + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updatePod + Updates a Pod. + false + + + id + the ID of the Pod + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + endip + the ending IP address for the Pod + false + string + + + gateway + the gateway for the Pod + false + string + + + name + the name of the Pod + false + string + + + netmask + the netmask of the Pod + false + string + + + startip + the starting IP address for the Pod + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + attachIso + Attaches an ISO to a virtual machine. + true + + + id + the ID of the ISO file + true + uuid + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + forced + If true, ejects existing ISO before attaching on VMware. Default: false + false + 4.15.1 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listBaremetalDhcp + list baremetal dhcp servers + false + + + physicalnetworkid + the Physical Network ID + true + uuid + + + dhcpservertype + Type of DHCP device + false + string + + + id + DHCP server device ID + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + device id of + string + + + dhcpservertype + name of the provider + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + disassociateIpAddress + Disassociates an IP address from the account. + true + + + id + the ID of the public IP address to disassociate + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + enableStorageMaintenance + Puts storage pool into maintenance state + true + + + id + Primary storage ID + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + name + the name of the storage pool + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + ldapRemove + (Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site. + false + 3.0.1 + + + + binddn + Specify the distinguished name of a user with the search permission on the directory + string + + + bindpass + DN password + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + string + + + port + Specify the LDAP port if required, default is 389 + string + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL + string + + + true + + + createUser + Creates a user for an account that already exists + false + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + true + string + + + email + email + true + string + + + firstname + firstname + true + string + + + lastname + lastname + true + string + + + password + Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Unique username. + true + string + + + domainid + Creates the user under the specified domain. Has to be accompanied with the account parameter + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + listApis + lists all available apis on the server, provided by the Api Discovery plugin + false + 4.1.0 + + + name + API name + false + string + + + + + description + description of the api + string + + + isasync + true if api is asynchronous + boolean + + + name + the name of the api command + string + + + related + comma separated related apis + string + + + since + version of CloudStack the api was introduced in + string + + + type + response field type + string + + + params(*) + the list params the api accepts + + + description + description of the api parameter + string + + + length + length of the parameter + int + + + name + the name of the api parameter + string + + + related + comma separated related apis to get the parameter + string + + + required + true if this parameter is required for the api request + boolean + + + since + version of CloudStack the api was introduced in + string + + + type + parameter type + string + + + set + + + response(*) + api response fields + + + description + description of the api response field + string + + + name + the name of the api response field + string + + + response + api response fields + set + + + type + response field type + string + + + set + + + false + + + deleteBaremetalRct + deletes baremetal rack configuration text + true + + + id + RCT id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVpnGateway + Creates site to site vpn local gateway + true + + + vpcid + public ip address id of the vpn gateway + true + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + createVMSnapshot + Creates snapshot for a vm. + true + 4.2.0 + + + virtualmachineid + The ID of the vm + true + uuid + + + description + The description of the snapshot + false + string + + + name + The display name of the snapshot + false + string + + + quiescevm + quiesce vm if true + false + boolean + + + snapshotmemory + snapshot memory if true + false + boolean + + + + + id + the ID of the vm snapshot + string + + + account + the account associated with the disk volume + string + + + created + the create date of the vm snapshot + date + + + current + indicates if this is current snapshot + boolean + + + description + the description of the vm snapshot + string + + + displayname + the display name of the vm snapshot + string + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + hypervisor + the type of hypervisor on which snapshot is stored + hypervisortype + + + name + the name of the vm snapshot + string + + + parent + the parent ID of the vm snapshot + string + + + parentName + the parent displayName of the vm snapshot + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the vm snapshot + state + + + type + VM Snapshot type + string + + + virtualmachineid + the vm ID of the vm snapshot + string + + + virtualmachinename + the vm name of the vm snapshot + 4.15.1 + string + + + zoneid + the Zone ID of the vm snapshot + string + + + zonename + the Zone name of the vm snapshot + 4.15.1 + string + + + false + + + addResourceDetail + Adds detail for the Resource. + true + + + details + Map of (key/value pairs) + true + map + map + + + resourceid + resource id to create the details for + true + string + + + resourcetype + type of the resource + true + string + + + fordisplay + pass false if you want this detail to be disabled for the regular user. True by default + false + 4.4 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVpnUsers + Lists vpn users + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + The uuid of the Vpn user + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + username + the username of the vpn user. + false + string + + + + + id + the vpn userID + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the Vpn User + string + + + username + the username of the vpn user + string + + + false + + + deleteLoadBalancer + Deletes an internal load balancer + true + 4.2.0 + + + id + the ID of the Load Balancer + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteIpForwardingRule + Deletes an IP forwarding rule + true + + + id + the ID of the forwarding rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + registerUserData + Register a new userdata. + false + 4.18 + + + name + Name of the userdata + true + string + + + userdata + Userdata content + true + string + + + account + an optional account for the userdata. Must be used with domainId. + false + string + + + domainid + an optional domainId for the userdata. If the account parameter is used, domainId must also be used. + false + uuid + + + params + comma separated list of variables declared in userdata content + false + string + + + projectid + an optional project for the userdata + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addRegion + Adds a Region + false + + + id + Id of the Region + true + integer + + + endpoint + Region service endpoint + true + string + + + name + Name of the region + true + string + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + listTungstenFabricTagType + Lists Tungsten-Fabric tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + tagtypeuuid + the uuid of Tungsten-Fabric tag type + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric tag type name + string + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + generateUsageRecords + Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed + false + + + enddate + End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + true + date + + + startdate + Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + true + date + + + domainid + List events for the specified domain. + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateRolePermission + Updates a role permission order + false + 4.9.0 + + + roleid + ID of the role + true + uuid + + + permission + Rule permission, can be: allow or deny + false + 4.11 + string + + + ruleid + Role permission rule id + false + 4.11 + uuid + + + ruleorder + The parent role permission uuid, use 0 to move this rule at the top of the list + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSSHKeyPairs + List registered keypairs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fingerprint + A public key fingerprint to look for + false + string + + + id + the ID of the ssh keypair + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + A key pair name to look for + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the keypair + string + + + domain + the domain name of the keypair owner + string + + + domainid + the domain id of the keypair owner + string + + + fingerprint + Fingerprint of the public key + string + + + name + Name of the keypair + string + + + project + the project name of the keypair owner + string + + + projectid + the project id of the keypair owner + string + + + false + + + listAccounts + Lists accounts and provides detailed account information for listed accounts + false + + + accounttype + list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user). + false + integer + + + details + comma separated list of account details requested, value can be a list of [ all, resource, min] + false + list + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list account by account ID + false + uuid + + + iscleanuprequired + list accounts by cleanuprequired attribute (values are true or false) + false + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list account by account name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for accounts + false + boolean + + + state + list accounts by state. Valid states are enabled, disabled, and locked. + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + cancelStorageMaintenance + Cancels maintenance for primary storage + true + + + id + the primary storage ID + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + name + the name of the storage pool + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + destroyRouter + Destroys a router. + true + + + id + the ID of the router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + quotaSummary + Lists balance and quota usage for all accounts + false + 4.7.0 + + + account + Optional, Account Id for which statement needs to be generated + false + string + + + domainid + Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain. + false + uuid + + + keyword + List by keyword + false + string + + + listall + Optional, to list all accounts irrespective of the quota activity + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + + + account + account name + string + + + accountid + account id + string + + + balance + account balance + bigdecimal + + + currency + currency + string + + + domain + domain name + string + + + domainid + domain id + string + + + enddate + end date + date + + + quota + quota usage of this period + bigdecimal + + + quotaenabled + if the account has the quota config enabled + boolean + + + startdate + start date + date + + + state + account state + state + + + false + + + updateSnapshotPolicy + Updates the snapshot policy. + true + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the snapshot policy to the end user or not. + false + 4.4 + boolean + + + id + the ID of the snapshot policy + false + uuid + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + false + + + queryAsyncJobResult + Retrieves the current status of asynchronous job. + false + + + jobid + the ID of the asynchronous job + true + uuid + + + + + accountid + the account that executed the async command + string + + + cmd + the async command executed + string + + + completed + the completed date of the job + date + + + created + the created date of the job + date + + + jobinstanceid + the unique ID of the instance/entity object related to the job + string + + + jobinstancetype + the instance/entity object related to the job + string + + + jobprocstatus + the progress information of the PENDING job + integer + + + jobresult + the result reason + responseobject + + + jobresultcode + the result code for the job + integer + + + jobresulttype + the result type + string + + + jobstatus + the current job status-should be 0 for PENDING + integer + + + userid + the user that executed the async command + string + + + jobid + the ID of the async job + + + false + + + registerNetscalerControlCenter + Adds a netscaler control center device + true + + + ipaddress + URL of the netscaler controlcenter appliance. + true + string + + + numretries + Credentials to reach netscaler controlcenter device + true + integer + + + password + Credentials to reach netscaler controlcenter device + true + string + + + username + Credentials to reach netscaler controlcenter device + true + string + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + listImageStores + Lists image stores. + false + 4.2.0 + + + id + the ID of the storage pool + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the image store + false + string + + + page + false + integer + + + pagesize + false + integer + + + protocol + the image store protocol + false + string + + + provider + the image store provider + false + string + + + readonly + read-only status of the image store + false + 4.15.0 + boolean + + + zoneid + the Zone ID for the image store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + deleteAccount + Deletes a account, and all users associated with this account + true + + + id + Account id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createCounter + Adds metric counter for VM auto scaling + true + + + name + Name of the counter. + true + string + + + provider + Network provider of the counter. + true + 4.18.0 + string + + + source + Source of the counter. + true + string + + + value + Value of the counter e.g. oid in case of snmp. + true + string + + + + + id + the id of the Counter + string + + + name + Name of the counter. + string + + + provider + Provider of the counter. + string + + + source + Source of the counter. + string + + + value + Value in case of snmp or other specific counters. + string + + + zoneid + zone id of counter + string + + + false + + + listEventTypes + List Event Types + false + + + + name + Event Type + string + + + false + + + disableOutOfBandManagementForCluster + Disables out-of-band management for a cluster + true + 4.9.0 + + + clusterid + the ID of the cluster + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + removeNicFromVirtualMachine + Removes VM from specified network by deleting a NIC + true + + + nicid + NIC ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteTrafficMonitor + Deletes an traffic monitor host. + false + + + id + Id of the Traffic Monitor Host. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addCluster + Adds a new cluster + false + + + clustername + the cluster name + true + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged + true + string + + + hypervisor + hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3 + true + string + + + podid + the Pod ID for the host + true + uuid + + + zoneid + the Zone ID for the cluster + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + guestvswitchname + Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting. + false + string + + + guestvswitchtype + Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch) + false + string + + + ovm3cluster + Ovm3 native OCFS2 clustering enabled for cluster + false + string + + + ovm3pool + Ovm3 native pooling enabled for cluster + false + string + + + ovm3vip + Ovm3 vip to use for pool (and cluster) + false + string + + + password + the password for the host + false + string + + + publicvswitchname + Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting. + false + string + + + publicvswitchtype + Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch) + false + string + + + url + the URL + false + string + + + username + the username for the cluster + false + string + + + vsmipaddress + the ipaddress of the VSM associated with this cluster + false + string + + + vsmpassword + the password for the VSM associated with this cluster + false + string + + + vsmusername + the username for the VSM associated with this cluster + false + string + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + deleteSslCert + Delete a certificate to CloudStack + false + + + id + Id of SSL certificate + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + activateProject + Activates a project + true + 3.0.0 + + + id + id of the project to be modified + true + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listDedicatedHosts + Lists dedicated hosts. + false + + + account + the name of the account associated with the host. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated hosts by affinity group + false + uuid + + + domainid + the ID of the domain associated with the host + false + uuid + + + hostid + the ID of the host + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the host + string + + + affinitygroupid + the Dedication Affinity Group ID of the host + string + + + domainid + the domain ID of the host + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + false + + + getUploadParamsForIso + upload an existing ISO into the CloudStack cloud. + false + 4.13 + + + displaytext + the display text of the ISO. This is usually used for display purposes. + true + string + + + format + the format for the volume/template. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the ISO + true + string + + + name + the name of the volume/template + true + string + + + zoneid + the ID of the zone the volume/template is to be hosted on + true + uuid + + + zoneid + the ID of the zone you wish to register the ISO to. + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + bootable + true if this ISO is bootable. If not passed explicitly its assumed to be true + false + boolean + + + checksum + the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isextractable + true if the ISO or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if you want this ISO to be featured + false + boolean + + + ispublic + true if you want to register the ISO to be publicly available to all users, false otherwise. + false + boolean + + + ostypeid + the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed + false + uuid + + + projectid + Upload volume/template for the project + false + uuid + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + getDiagnosticsData + Get diagnostics and files from system VMs + true + 4.14.0.0 + + + targetid + The ID of the system VM instance to retrieve diagnostics data files from + true + uuid + + + files + A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided. + false + list + list + + + + + url + Storage URL to download retrieve diagnostics data files + string + + + false + + + listPaloAltoFirewalls + lists Palo Alto firewall devices in a physical network + false + + + fwdeviceid + Palo Alto firewall device ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + deleteAutoScaleVmGroup + Deletes a autoscale vm group. + true + + + id + the ID of the autoscale group + true + uuid + + + cleanup + true if all VMs have to be cleaned up, false otherwise + false + 4.18.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateLoadBalancerRule + Updates load balancer + true + + + id + the ID of the load balancer rule to update + true + uuid + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + description + the description of the load balancer rule + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + name + the name of the load balancer rule + false + string + + + protocol + The protocol for the LB + false + string + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteAlerts + Delete one or more alerts. + false + + + enddate + end date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the alerts + false + list + list + + + startdate + start date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + delete by alert type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + enableAccount + Enables an account + false + + + account + Enables specified account. + false + string + + + domainid + Enables specified account in this domain. + false + uuid + + + id + Account id + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + createAutoScaleVmProfile + Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature. + true + + + serviceofferingid + the service offering of the auto deployed virtual machine + true + uuid + + + templateid + the template of the auto deployed virtual machine + true + uuid + + + zoneid + availability zone for the auto deployed virtual machine + true + uuid + + + account + account that will own the autoscale VM profile + false + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + false + uuid + + + counterparam + counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161 + false + map + map + + + domainid + domain ID of the account owning a autoscale VM profile + false + uuid + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is expunged + false + integer + + + fordisplay + an optional field, whether to the display the profile to the end user or not + false + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. +Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 . +Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". + false + map + map + + + projectid + an optional project for the autoscale VM profile + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value + false + 4.18.0 + string + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base 64 encoded VM user data + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + listLBStickinessPolicies + Lists load balancer stickiness policies. + false + 3.0.0 + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer stickiness policy + false + uuid + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the load balancer rule + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + addUcsManager + Adds a Ucs manager + false + + + password + the password of UCS + true + string + + + url + the name of UCS url + true + string + + + username + the username of UCS + true + string + + + zoneid + the Zone id for the ucs manager + true + uuid + + + name + the name of UCS manager + false + string + + + + + id + the ID of the ucs manager + string + + + name + the name of ucs manager + string + + + url + the url of ucs manager + string + + + zoneid + the zone ID of ucs manager + string + + + false + + + deleteNetwork + Deletes a network + true + + + id + the ID of the network + true + uuid + + + forced + Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + reconnectHost + Reconnects a host. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + hypervisortype + + + hypervisorversion + the hypervisor version + string + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + startKubernetesCluster + Starts a stopped Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + deleteProject + Deletes a project + true + 3.0.0 + + + id + id of the project to be deleted + true + uuid + + + cleanup + true if all project resources have to be cleaned up, false otherwise + false + 4.16.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetscalerLoadBalancers + lists netscaler load balancer devices + false + + + keyword + List by keyword + false + string + + + lbdeviceid + netscaler load balancer device ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + createInstanceGroup + Creates a vm group + false + + + name + the name of the instance group + true + string + + + account + the account of the instance group. The account parameter must be used with the domainId parameter. + false + string + + + domainid + the domain ID of account owning the instance group + false + uuid + + + projectid + The project of the instance group + false + uuid + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + listIsoPermissions + List iso visibility and all accounts that have permissions to view this iso. + false + + + id + the template ID + true + uuid + + + + + id + the template ID + string + + + account + the list of accounts the template is available for + list + + + domainid + the ID of the domain to which the template belongs + string + + + ispublic + true if this template is a public template, false otherwise + boolean + + + projectids + the list of projects the template is available for + list + + + false + + + addNetscalerLoadBalancer + Adds a netscaler load balancer device + true + + + networkdevicetype + Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer + true + string + + + password + Credentials to reach netscaler load balancer device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the netscaler load balancer appliance. + true + string + + + username + Credentials to reach netscaler load balancer device + true + string + + + gslbprovider + true if NetScaler device being added is for providing GSLB service + false + boolean + + + gslbproviderprivateip + private IP of the site + false + string + + + gslbproviderpublicip + public IP of the site + false + string + + + isexclusivegslbprovider + true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB + false + boolean + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + createLoadBalancer + Creates an internal load balancer + true + 4.2.0 + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + true + string + + + instanceport + the TCP port of the virtual machine where the network traffic will be load balanced to + true + integer + + + name + name of the load balancer + true + string + + + networkid + The guest network the load balancer will be created for + true + uuid + + + scheme + the load balancer scheme. Supported value in this release is Internal + true + string + + + sourceipaddressnetworkid + the network id of the source ip address + true + uuid + + + sourceport + the source port the network traffic will be load balanced from + true + integer + + + description + the description of the load balancer + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + sourceipaddress + the source IP address the network traffic will be load balanced from + false + string + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + restoreVolumeFromBackupAndAttachToVM + Restore and attach a backed up volume to VM + true + 4.14.0 + + + backupid + ID of the VM backup + true + uuid + + + virtualmachineid + id of the VM where to attach the restored volume + true + uuid + + + volumeid + ID of the volume backed up + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBackupSchedule + List backup schedule of a VM + false + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + intervaltype + the interval type of the backup schedule + intervaltype + + + schedule + time the backup is scheduled to be taken. + string + + + timezone + the time zone of the backup schedule + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + false + + + configTungstenFabricService + config Tungsten-Fabric service + false + + + physicalnetworkid + the ID of physical network + true + uuid + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + removeNetworkPermissions + Removes network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + accountids + a comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + accounts + a comma delimited list of accounts within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + projectids + a comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateBackupSchedule + Updates a user-defined VM backup schedule + false + 4.14.0 + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + schedule + custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + string + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + addPaloAltoFirewall + Adds a Palo Alto firewall device + true + + + networkdevicetype + supports only PaloAltoFirewall + true + string + + + password + Credentials to reach Palo Alto firewall device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the Palo Alto appliance. + true + string + + + username + Credentials to reach Palo Alto firewall device + true + string + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + listBaremetalPxeServers + list baremetal pxe server + false + + + physicalnetworkid + the Physical Network ID + true + uuid + + + id + Pxe server device ID + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + device id of + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + createPrivateGateway + Creates a private gateway + true + 4.17.0 + + + gateway + the gateway of the Private gateway + true + string + + + ipaddress + the IP address of the Private gateaway + true + string + + + netmask + the netmask of the Private gateway + true + string + + + vpcid + the VPC network belongs to + true + uuid + + + aclid + the ID of the network ACL + false + uuid + + + associatednetworkid + The isolated network this private gateway is associated to. + false + 4.17.0 + uuid + + + bypassvlanoverlapcheck + when true bypasses VLAN id/range overlap check during private gateway creation + false + boolean + + + networkofferingid + the uuid of the network offering to use for the private gateways network connection + false + uuid + + + physicalnetworkid + the Physical Network ID the network belongs to + false + uuid + + + sourcenatsupported + source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported + false + boolean + + + vlan + the network implementation uri for the private gateway + false + string + + + + + id + the id of the private gateway + string + + + account + the account associated with the private gateway + string + + + aclid + ACL Id set for private gateway + string + + + aclname + ACL name set for private gateway + string + + + domain + the domain associated with the private gateway + string + + + domainid + the ID of the domain associated with the private gateway + string + + + gateway + the gateway + string + + + ipaddress + the private gateway's ip address + string + + + netmask + the private gateway's netmask + string + + + physicalnetworkid + the physical network id + string + + + project + the project name of the private gateway + string + + + projectid + the project id of the private gateway + string + + + sourcenatsupported + Source Nat enable status + boolean + + + state + State of the gateway, can be Creating, Ready, Deleting + string + + + vlan + the network implementation uri for the private gateway + string + + + vpcid + VPC id the private gateway belongs to + string + + + vpcname + VPC name the private gateway belongs to + 4.13.2 + string + + + zoneid + zone id of the private gateway + string + + + zonename + the name of the zone the private gateway belongs to + string + + + false + + + getUser + Find user account by API key + false + + + userapikey + API key of the user + true + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + listLoadBalancerRules + Lists load balancer rules. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer rule + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the load balancer rule + false + string + + + networkid + list by network ID the rule belongs to + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + publicipid + the public IP address ID of the load balancer rule + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + the ID of the virtual machine of the load balancer rule + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteFirewallRule + Deletes a firewall rule + true + + + id + the ID of the firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + uploadSslCert + Upload a certificate to CloudStack + false + + + certificate + SSL certificate + true + string + + + name + Name for the uploaded certificate + true + string + + + privatekey + Private key + true + string + + + account + account that will own the SSL certificate + false + string + + + certchain + Certificate chain of trust + false + string + + + domainid + domain ID of the account owning the SSL certificate + false + uuid + + + enabledrevocationcheck + Enables revocation checking for certificates + false + 4.15 + boolean + + + password + Password for the private key + false + string + + + projectid + an optional project for the SSL certificate + false + uuid + + + + + id + SSL certificate ID + string + + + account + account for the certificate + string + + + certchain + certificate chain + string + + + certificate + certificate + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + fingerprint + certificate fingerprint + string + + + loadbalancerrulelist + List of loabalancers this certificate is bound to + list + + + name + name + string + + + project + the project name of the certificate + string + + + projectid + the project id of the certificate + string + + + false + + + createVpnCustomerGateway + Creates site to site vpn customer gateway + true + + + cidrlist + guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,). + true + string + + + esppolicy + ESP policy of the customer gateway + true + string + + + gateway + public ip address id of the customer gateway + true + string + + + ikepolicy + IKE policy of the customer gateway + true + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes. + true + string + + + account + the account associated with the gateway. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain. + false + uuid + + + dpd + If DPD is enabled for VPN connection + false + boolean + + + esplifetime + Lifetime of phase 2 VPN connection to the customer gateway, in seconds + false + long + + + forceencap + Force Encapsulation for NAT traversal + false + boolean + + + ikelifetime + Lifetime of phase 1 VPN connection to the customer gateway, in seconds + false + long + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike + false + 4.15.1 + string + + + name + name of this customer gateway + false + string + + + projectid + create site-to-site VPN customer gateway for the project + false + 4.6 + uuid + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + false + 4.15.1 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + createManagementNetworkIpRange + Creates a Management network IP range. + true + 4.11.0.0 + + + gateway + The gateway for the management network. + true + string + + + netmask + The netmask for the management network. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + startip + The starting IP address. + true + string + + + endip + The ending IP address. + false + string + + + forsystemvms + Specify if range is dedicated for CPVM and SSVM. + false + boolean + + + vlan + Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + listCiscoNexusVSMs + Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster + false + + + clusterid + Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance. + false + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + addVpnUser + Adds vpn users + true + + + password + password for the username + true + string + + + username + username for the vpn user + true + string + + + account + an optional account for the vpn user. Must be used with domainId. + false + string + + + domainid + an optional domainId for the vpn user. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + add vpn user to the specific project + false + uuid + + + + + id + the vpn userID + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the Vpn User + string + + + username + the username of the vpn user + string + + + false + + + deleteBackup + Delete VM backup + true + 4.14.0 + + + id + id of the VM backup + true + uuid + + + forced + force the deletion of backup which removes the entire backup chain but keep VM in Backup Offering + false + 4.18.0.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + removeAnnotation + remove an annotation. + false + 4.11 + + + id + the id of the annotation + true + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + addBaremetalHost + add a baremetal host + false + + + hypervisor + hypervisor type of the host + true + string + + + podid + the Pod ID for the host + true + uuid + + + url + the host URL + true + string + + + zoneid + the Zone ID for the host + true + uuid + + + allocationstate + Allocation state of this Host for allocation of new resources + false + string + + + clusterid + the cluster ID for the host + false + uuid + + + clustername + the cluster name for the host + false + string + + + hosttags + list of tags to be added to the host + false + list + list + + + ipaddress + ip address intentionally allocated to this host after provisioning + false + string + + + password + the password for the host; required to be passed for hypervisors other than VMWare + false + string + + + username + the username for the host; required to be passed for hypervisors other than VMWare + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + hypervisortype + + + hypervisorversion + the hypervisor version + string + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteProjectRolePermission + Deletes a project role permission in the project + false + 4.15.0 + + + id + ID of the project role permission to be deleted + true + uuid + + + projectid + ID of the project where the project role permission is to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteRolePermission + Deletes a role permission + false + 4.9.0 + + + id + ID of the role permission + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listConfigurationGroups + Lists all configuration groups (primarily used for UI). + false + 4.18.0 + + + group + lists configuration group by group name + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + description + the description of the configuration group + string + + + name + the name of the configuration group + string + + + precedence + the precedence of the configuration group + long + + + subgroup(*) + the subgroups of the configuration group + + + name + the name of the configuration subgroup + string + + + precedence + the precedence of the configuration subgroup + long + + + list + + + false + + + releasePodIpAddress + Releases a Pod IP back to the Pod + false + + + id + UUID of the Pod IP + true + long + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateRemoteAccessVpn + Updates remote access vpn + true + 4.4 + + + id + id of the remote access vpn + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + updateVPCOffering + Updates VPC offering + true + + + id + the id of the VPC offering + true + uuid + + + displaytext + the display text of the VPC offering + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + name + the name of the VPC offering + false + string + + + sortkey + sort key of the VPC offering, integer + false + integer + + + state + update state for the VPC offering; supported states - Enabled/Disabled + false + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + listSamlAuthorization + Lists authorized users who can used SAML SSO + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + userid + User uuid + false + uuid + + + + + idpid + the authorized Identity Provider ID + string + + + status + the SAML authorization status + boolean + + + userid + the user ID + string + + + false + + + listUserTwoFactorAuthenticatorProviders + Lists user two factor authenticator providers + false + 4.18.0 + + + name + List user two factor authenticator provider by name + false + string + + + + + description + the description of the user two factor authenticator provider + string + + + name + the user two factor authenticator provider name + string + + + false + + + scaleVirtualMachine + Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume. + true + + + id + The ID of the virtual machine + true + uuid + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + automigrate + Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering + false + 4.17 + boolean + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + maxiops + New maximum number of IOPS for the custom disk offering + false + 4.17 + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + 4.17 + long + + + shrinkok + Verify OK to Shrink + false + 4.17 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + destroyVirtualMachine + Destroys a virtual machine. Once destroyed, only the administrator can recover it. + true + + + id + The ID of the virtual machine + true + uuid + + + expunge + If true is passed, the vm is expunged immediately. False by default. + false + 4.2.1 + boolean + + + volumeids + Comma separated list of UUIDs for volumes that will be deleted + false + list + 4.12.0 + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateEgressFirewallRule + Updates egress firewall rule + true + 4.4 + + + id + the ID of the egress firewall rule + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listServiceOfferings + Lists all available service offerings. + false + + + cpunumber + the CPU number that listed offerings must support + false + 4.15 + integer + + + cpuspeed + the CPU speed that listed offerings must support + false + 4.15 + integer + + + domainid + list only resources belonging to the domain specified + false + uuid + + + encryptroot + listed offerings support root disk encryption + false + 4.18 + boolean + + + id + ID of the service offering + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issystem + is this a system vm offering + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + memory + the RAM memory that listed offering must support + false + 4.15 + integer + + + name + name of the service offering + false + string + + + page + false + integer + + + pagesize + false + integer + + + systemvmtype + the system VM type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter". + false + string + + + virtualmachineid + the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to. + false + uuid + + + zoneid + id of zone disk offering is associated with + false + 4.13 + uuid + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + listOsCategories + Lists all supported OS categories for this cloud. + false + + + id + list Os category by id + false + uuid + + + keyword + List by keyword + false + string + + + name + list os category by name + false + 3.0.1 + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the OS category + string + + + name + the name of the OS category + string + + + false + + + removeFromGlobalLoadBalancerRule + Removes a load balancer rule association with global load balancer rule + true + + + id + The ID of the load balancer rule + true + uuid + + + loadbalancerrulelist + the list load balancer rules that will be assigned to global load balancer rule + true + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + assignVirtualMachineToBackupOffering + Assigns a VM to a backup offering + true + 4.14.0 + + + backupofferingid + ID of the backup offering + true + uuid + + + virtualmachineid + ID of the virtual machine + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAffinityGroupTypes + Lists affinity group types available + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + type + the type of the affinity group + string + + + false + + + listCapacity + Lists all the system wide capacities. + false + + + clusterid + lists capacity by the Cluster ID + false + 3.0.0 + uuid + + + fetchlatest + recalculate capacities and fetch the latest + false + 3.0.0 + boolean + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists capacity by the Pod ID + false + uuid + + + sortby + Sort the results. Available values: Usage + false + 3.0.0 + string + + + type + lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90. + false + integer + + + zoneid + lists capacity by the Zone ID + false + uuid + + + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + false + + + startVirtualMachine + Starts a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + bootintosetup + Boot into hardware setup menu or not + false + 4.15.0.0 + boolean + + + clusterid + destination Cluster ID to deploy the VM to - parameter available for root admin only + false + uuid + + + considerlasthost + True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process. + false + 4.18.0 + boolean + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + 3.0.1 + uuid + + + podid + destination Pod ID to deploy the VM to - parameter available for root admin only + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + stopVirtualMachine + Stops a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). The caller knows the VM is stopped. + false + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + zoneid + the ID of the availablility zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateServiceOffering + Updates a service offering. + false + + + id + the ID of the service offering to be updated + true + uuid + + + displaytext + the display text of the service offering to be updated + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + hosttags + the host tag for this service offering. + false + 4.16 + string + + + name + the name of the service offering to be updated + false + string + + + sortkey + sort key of the service offering, integer + false + integer + + + storagetags + comma-separated list of tags for the service offering, tags should match with existing storage pool tags + false + 4.16 + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + createNetworkACLList + Creates a network ACL for the given VPC + true + + + name + Name of the network ACL list + true + string + + + vpcid + ID of the VPC associated with this network ACL list + true + uuid + + + description + Description of the network ACL list + false + string + + + fordisplay + an optional field, whether to the display the list to the end user or not + false + 4.4 + boolean + + + + + id + the ID of the ACL + string + + + description + Description of the ACL + string + + + fordisplay + is ACL for display to the regular user + 4.4 + boolean + + + name + the Name of the ACL + string + + + vpcid + Id of the VPC this ACL is associated with + string + + + vpcname + Name of the VPC this ACL is associated with + string + + + false + + \ No newline at end of file diff --git a/4.19.2_commands.xml b/4.19.2_commands.xml new file mode 100644 index 0000000..247dc60 --- /dev/null +++ b/4.19.2_commands.xml @@ -0,0 +1,130409 @@ + + + createVPCOffering + Creates VPC offering + true + + + name + the name of the vpc offering + true + string + + + supportedservices + services supported by the vpc offering + true + list + list + + + displaytext + the display text of the vpc offering, defaults to the 'name' + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + enable + set to true if the offering is to be enabled during creation. Default is false + false + 4.16 + boolean + + + internetprotocol + The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6 + false + 4.17.0 + string + + + servicecapabilitylist + desired service capabilities as part of vpc offering + false + map + 4.4 + map + + + serviceofferingid + the ID of the service offering for the VPC router appliance + false + uuid + + + serviceproviderlist + provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network + false + map + map + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + ldapCreateAccount + Creates an account from an LDAP user + false + 4.2.0 + + + username + Unique username. + true + string + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accountid + Account UUID, required for adding account from external provisioning system + false + string + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + Creates the user under the specified domain. + false + uuid + + + networkdomain + Network domain for the account's networks + false + string + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + copyIso + Copies an iso from one zone to another. + true + + + id + Template ID. + true + uuid + + + destzoneid + ID of the zone the template is being copied to. + false + uuid + + + destzoneids + 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. + false + list + list + + + sourcezoneid + 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. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteAutoScaleVmProfile + Deletes a autoscale vm profile. + true + + + id + the ID of the autoscale profile + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVsphereStoragePolicyCompatiblePools + List storage pools compatible with a vSphere storage policy + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + policyid + ID of the storage policy + false + uuid + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + rebootSystemVm + Reboots a system VM. + true + + + id + The ID of the system virtual machine + true + uuid + + + forced + Force reboot the system VM (System VM is Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + listDedicatedZones + List dedicated zones. + false + + + account + the name of the account associated with the zone. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated zones by affinity group + false + uuid + + + domainid + the ID of the domain associated with the zone + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of the Zone + false + uuid + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Zone is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the zone + string + + + domainid + the domain ID to which the Zone is dedicated + string + + + zoneid + the ID of the Zone + string + + + zonename + the Name of the Zone + string + + + false + + + listElastistorPool + Lists the pools of elastistor + false + + + id + the ID of the Pool + false + long + + + + + id + the ID of the storage pool + string + + + controllerid + controller of the pool + string + + + gateway + default gateway of the pool + string + + + maxiops + available iops of the pool + long + + + name + the name of the storage pool + string + + + size + the current available space of the pool + long + + + state + the state of the storage pool + string + + + false + + + listTungstenFabricLBHealthMonitor + list Tungsten-Fabric LB health monitor + false + + + lbruleid + the ID of lb rule + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the health monitor ID + long + + + expectedcode + the health monitor expected code + string + + + httpmethod + the health monitor http method + string + + + interval + the health monitor interval + int + + + lbruleid + the LB rule ID + string + + + retry + the health monitor retry + int + + + timeout + the health monitor timeout + int + + + type + the health monitor type + string + + + urlpath + the health monitor url path + string + + + uuid + the health monitor UUID + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + deleteAccountFromProject + Deletes account from the project + true + 3.0.0 + + + account + name of the account to be removed from the project + true + string + + + projectid + ID of the project to remove the account from + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateGuestOs + Updates the information about Guest OS + true + 4.4.0 + + + id + UUID of the Guest OS + true + uuid + + + osdisplayname + Unique display name for Guest OS + true + string + + + details + Map of (key/value pairs) + false + map + map + + + forDisplay + whether this guest OS is available for end users + false + boolean + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + fordisplay + is the guest OS visible for the users + boolean + + + isuserdefined + is the guest OS user defined + boolean + + + name + the name of the OS type + string + + + oscategoryid + the ID of the OS category + string + + + oscategoryname + the name of the OS category + string + + + false + + + listGuestVlans + Lists all guest vlans + false + 4.17.0 + + + allocatedonly + limits search results to allocated guest vlan. false by default. + false + boolean + + + id + list guest vlan by id + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + list guest vlan by physical network + false + uuid + + + vnet + list guest vlan by vnet + false + string + + + zoneid + list guest vlan by zone + false + uuid + + + + + id + the guest VLAN id + long + + + account + the account of the guest VLAN range + string + + + allocationstate + the allocation state of the guest VLAN + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + domainpath + path of the domain to which the guest VLAN range belongs + 4.19.2.0 + string + + + isdedicated + true if the guest VLAN is dedicated to the account + boolean + + + network + the list of networks who use this guest VLAN + list + + + physicalnetworkid + the physical network ID of the guest VLAN range + string + + + physicalnetworkname + the physical network name of the guest VLAN range + string + + + project + the project name of the guest VLAN range + string + + + projectid + the project id of the guest VLAN range + string + + + taken + date the guest VLAN was taken + date + + + vlan + the guest VLAN + string + + + zoneid + the zone ID of the guest VLAN range + string + + + zonename + the zone name of the guest VLAN range + string + + + false + + + updateResourceLimit + Updates resource limits for an account or domain. + false + + + resourcetype + Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + true + integer + + + account + Update resource for a specified account. Must be used with the domainId parameter. + false + string + + + domainid + 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. + false + uuid + + + max + Maximum resource limit. + false + long + + + projectid + Update resource limits for project + false + uuid + + + + + account + the account of the resource limit + string + + + domain + the domain name of the resource limit + string + + + domainid + the domain ID of the resource limit + string + + + domainpath + path of the domain to which the resource limit belongs + 4.19.2.0 + string + + + max + the maximum number of the resource. A -1 means the resource currently has no limit. + long + + + project + the project name of the resource limit + string + + + projectid + the project id of the resource limit + string + + + resourcetype + 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. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + false + + + getLoadBalancerSslCertificate + get load balancer certificate + false + + + id + the ID of Lb + true + uuid + + + + + chain + chain + string + + + crt + crt + string + + + key + key + string + + + false + + + deleteStaticRoute + Deletes a static route + true + + + id + the ID of the static route + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + startRollingMaintenance + Start rolling maintenance + true + + + clusterids + the IDs of the clusters to start maintenance on + false + list + list + + + forced + if rolling mechanism should continue in case of an error + false + boolean + + + hostids + the IDs of the hosts to start maintenance on + false + list + list + + + payload + the command to execute while hosts are on maintenance + false + string + + + podids + the IDs of the pods to start maintenance on + false + list + list + + + timeout + optional operation timeout (in seconds) that overrides the global timeout setting + false + integer + + + zoneids + the IDs of the zones to start maintenance on + false + list + list + + + + + details + in case of failure, details are displayed + string + + + success + indicates if the rolling maintenance operation was successful + boolean + + + hostsskipped(*) + the hosts skipped + + + hostid + the ID of the skipped host + string + + + hostname + the name of the skipped host + string + + + reason + the reason to skip the host + string + + + list + + + hostsupdated(*) + the hosts updated + + + enddate + end date of the update on the host + string + + + hostid + the ID of the updated host + string + + + hostname + the name of the updated host + string + + + output + output of the maintenance script on the host + string + + + startdate + start date of the update on the host + string + + + list + + + false + + + deleteRemoteAccessVpn + Destroys a l2tp/ipsec remote access vpn + true + + + publicipid + public ip address id of the vpn server + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricApplicationPolicySet + list Tungsten-Fabric application policy set + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + firewallpolicy + list Tungsten-Fabric firewall policy + list + + + name + Tungsten-Fabric policy name + string + + + tag + list Tungsten-Fabric tag + list + + + uuid + Tungsten-Fabric application policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateNetworkACLList + Updates network ACL list + true + 4.4 + + + id + the ID of the network ACL + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + description + Description of the network ACL list + false + string + + + fordisplay + an optional field, whether to the display the list to the end user or not + false + 4.4 + boolean + + + name + Name of the network ACL list + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + restoreVirtualMachine + Restore a VM to original template/ISO or new template/ISO + true + 3.0.0 + + + virtualmachineid + Virtual Machine ID + true + uuid + + + details + used to specify the custom parameters + false + map + 4.19.1 + map + + + diskofferingid + Override root volume's diskoffering. + false + 4.19.1 + uuid + + + expunge + Optional field to expunge old root volume after restore. + false + 4.19.1 + boolean + + + rootdisksize + Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.19.1 + long + + + templateid + 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 + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteNiciraNvpDevice + delete a nicira nvp device + true + + + nvpdeviceid + Nicira device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getVolumeSnapshotDetails + Get Volume Snapshot Details + false + + + snapshotid + CloudStack Snapshot UUID + true + string + + + + + volumeiScsiName + Volume iSCSI Name + string + + + false + + + notifyBaremetalProvisionDone + Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user + true + + + mac + mac of the nic used for provision + true + object + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUcsBlades + List ucs blades + false + + + ucsmanagerid + ucs manager id + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + ucs blade id + string + + + bladedn + ucs blade dn + string + + + hostid + cloudstack host id this blade associates to + string + + + profiledn + associated ucs profile dn + string + + + ucsmanagerid + ucs manager id + string + + + false + + + updateHost + Updates a host. + false + + + id + the ID of the host to update + true + uuid + + + allocationstate + Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable + false + string + + + annotation + Add an annotation to this host + false + 4.11 + string + + + hosttags + list of tags to be added to the host + false + list + list + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + false + boolean + + + name + Change the name of host + false + 4.15 + string + + + oscategoryid + the id of Os category to update the host with + false + uuid + + + url + the new uri for the secondary storage: nfs://host/path + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createEgressFirewallRule + Creates a egress firewall rule for a given network + true + + + networkid + the network id of the port forwarding rule + true + uuid + + + protocol + the protocol for the firewall rule. Valid values are TCP/UDP/ICMP. + true + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + destcidrlist + the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + startport + the starting port of firewall rule + false + integer + + + type + type of firewallrule: system/user + false + string + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listSecurityGroups + Lists security groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list the security group by the id provided + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + securitygroupname + lists security groups by name + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + lists security groups by virtual machine id + false + uuid + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listOauthProvider + List OAuth providers registered + false + 4.19.0 + + + id + the ID of the OAuth provider + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + Name of the provider + false + string + + + + + id + ID of the provider + string + + + clientid + Client ID registered in the OAuth provider + string + + + description + Description of the provider registered + string + + + enabled + Whether the OAuth provider is enabled or not + boolean + + + name + Name of the provider + string + + + provider + Name of the provider + string + + + redirecturi + Redirect URI registered in the OAuth provider + string + + + secretkey + Secret key registered in the OAuth provider + string + + + false + + + deleteServicePackageOffering + Delete Service Package + false + + + id + the service offering ID + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + destroySystemVm + Destroys a system virtual machine. + true + + + id + The ID of the system virtual machine + true + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + archiveEvents + Archive one or more events. + false + + + enddate + end date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the events + false + list + list + + + startdate + start date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + archive by event type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSecondaryStagingStore + Deletes a secondary staging store . + false + 4.2.0 + + + id + the staging store ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUserData + List registered userdatas + false + 4.18 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the Userdata + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + Userdata name to look for + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the userdata + string + + + accountid + the owner id of the userdata + string + + + domain + the domain name of the userdata owner + string + + + domainid + the domain id of the userdata owner + string + + + domainpath + path of the domain to which the userdata owner belongs + 4.19.2.0 + string + + + name + Name of the userdata + string + + + params + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + string + + + project + the project name of the userdata + 4.19.1 + string + + + projectid + the project id of the userdata + 4.19.1 + string + + + userdata + base64 encoded userdata content + string + + + false + + + updateLoadBalancer + Updates an internal load balancer + true + 4.4.0 + + + id + the ID of the load balancer + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + domainpath + path of the domain to which the Load Balancer belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + scaleSystemVm + Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect. + true + + + id + The ID of the system vm + true + uuid + + + serviceofferingid + the service offering ID to apply to the system vm + true + uuid + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + verifyOAuthCodeAndGetUser + Verify the OAuth Code and fetch the corresponding user from provider + false + 4.19.0 + + + provider + Name of the provider + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + secretcode + Code that is provided by OAuth provider (Eg. google, github) after successful login + false + string + + + + + id + ID of the provider + string + + + clientid + Client ID registered in the OAuth provider + string + + + description + Description of the provider registered + string + + + enabled + Whether the OAuth provider is enabled or not + boolean + + + name + Name of the provider + string + + + provider + Name of the provider + string + + + redirecturi + Redirect URI registered in the OAuth provider + string + + + secretkey + Secret key registered in the OAuth provider + string + + + false + + + listClusterDrsPlan + List DRS plans for a clusters + false + 4.19.0 + + + clusterid + ID of the cluster + false + uuid + + + id + ID of the drs plan + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + unique ID of the drs plan for cluster + string + + + clusterid + Id of the cluster + string + + + eventid + Start event Id of the DRS Plan + string + + + migrations + List of migrations + list + + + status + Status of DRS Plan + status + + + type + Type of DRS Plan (Automated or Manual)) + type + + + false + + + listClusters + Lists clusters. + false + + + allocationstate + lists clusters by allocation state + false + string + + + clustertype + lists clusters by cluster type + false + string + + + hypervisor + lists clusters by hypervisor type + false + string + + + id + lists clusters by the cluster ID + false + uuid + + + keyword + List by keyword + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + name + lists clusters by the cluster name + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists clusters by Pod ID + false + uuid + + + showcapacities + flag to display the capacity of the clusters + false + boolean + + + zoneid + lists clusters by Zone ID + false + uuid + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + listProjectInvitations + Lists project invitations and provides detailed information for listed invitations + false + 3.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + activeonly + if true, list only active invitations - having Pending state and ones that are not timed out yet + false + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list invitations by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list by project id + false + uuid + + + state + list invitations by state + false + string + + + userid + list invitation by user ID + false + uuid + + + + + id + the id of the invitation + string + + + account + the account name of the project's owner + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + domainpath + path of the Domain the project belongs to + 4.19.2.0 + string + + + email + the email the invitation was sent to + string + + + project + the name of the project + string + + + projectid + the id of the project + string + + + state + the invitation state + string + + + userid + the User ID + string + + + false + + + listEgressFirewallRules + Lists all egress firewall rules for network ID. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the firewall services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + the network ID for the egress firewall services + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listClustersMetrics + Lists clusters metrics + false + 4.9.3 + + + allocationstate + lists clusters by allocation state + false + string + + + clustertype + lists clusters by cluster type + false + string + + + hypervisor + lists clusters by hypervisor type + false + string + + + id + lists clusters by the cluster ID + false + uuid + + + keyword + List by keyword + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + name + lists clusters by the cluster name + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists clusters by Pod ID + false + uuid + + + showcapacities + flag to display the capacity of the clusters + false + boolean + + + zoneid + lists clusters by Zone ID + false + uuid + + + + + cpuallocated + the total cpu allocated in Ghz + string + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpumaxdeviation + the maximum cpu deviation + string + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotal + the total cpu capacity in Ghz + string + + + cpuused + the total cpu used in Ghz + string + + + drsimbalance + DRS imbalance for the cluster + string + + + hosts + running / total hosts in the cluster + string + + + memoryallocated + the total cpu allocated in GiB + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorymaxdeviation + the maximum memory deviation + string + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotal + the total cpu capacity in GiB + string + + + memoryused + the total cpu used in GiB + string + + + state + state of the cluster + string + + + false + + + listStoragePoolObjects + Lists objects at specified path on a storage pool. + false + 4.19.0 + + + id + id of the storage pool + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + path to list on storage pool + false + string + + + + + format + Format of template associated with the data store object. + string + + + isdirectory + Is it a directory. + boolean + + + lastupdated + Last modified date of the file/directory. + date + + + name + Name of the data store object. + string + + + size + Size is in Bytes. + long + + + snapshotid + Snapshot ID associated with the data store object. + string + + + templateid + Template ID associated with the data store object. + string + + + volumeid + Volume ID associated with the data store object. + string + + + false + + + createBackupSchedule + Creates a user-defined VM backup schedule + false + 4.14.0 + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + schedule + custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + date + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + listSecondaryStagingStores + Lists secondary staging stores. + false + 4.2.0 + + + id + the ID of the staging store + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the staging store + false + string + + + page + false + integer + + + pagesize + false + integer + + + protocol + the staging store protocol + false + string + + + provider + the staging store provider + false + string + + + zoneid + the Zone ID for the staging store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + startRouter + Starts a router. + true + + + id + the ID of the router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + resetConfiguration + Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings + false + 4.16.0 + + + name + the name of the configuration + true + string + + + accountid + the ID of the Account to reset the parameter value for corresponding account + false + uuid + + + clusterid + the ID of the Cluster to reset the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to reset the parameter value for corresponding domain + false + uuid + + + imagestoreid + the ID of the Image Store to reset the parameter value for corresponding image store + false + uuid + + + storageid + the ID of the Storage pool to reset the parameter value for corresponding storage pool + false + uuid + + + zoneid + the ID of the Zone to reset the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + deleteStratosphereSsp + Removes stratosphere ssp server + false + + + hostid + the host ID of ssp server + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createAutoScalePolicy + Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group. + true + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + true + string + + + conditionids + the list of IDs of the conditions that are being evaluated on every interval + true + list + list + + + duration + the duration in which the conditions have to be true before action is taken + true + integer + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + quiettime + the cool down period in which the policy should not be evaluated after the action has been taken + false + integer + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + domainpath + path of the domain to which the autoscale policy belongs + 4.19.2.0 + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + listUsageServerMetrics + Lists Usage Server metrics + false + 4.17.0 + + + + collectiontime + the time these statistics were collected + date + + + hostname + the name of the active usage server + string + + + lastheartbeat + the last time this Usage Server checked for jobs + date + + + lastsuccessfuljob + the last time a usage job successfully completed + date + + + state + the state of the usage server + state + + + false + + + enableHAForZone + Enables HA for a zone + true + 4.11 + + + zoneid + ID of the zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + cleanVMReservations + Cleanups VM reservations in the database. + true + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listObjectStoragePools + Lists object storage pools. + false + 4.19.0 + + + id + the ID of the storage pool + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the object store + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + the object store provider + false + string + + + + + id + the ID of the object store + string + + + name + the name of the object store + string + + + providername + the provider name of the object store + string + + + storagetotal + the total size of the object store + long + + + storageused + the object store currently used size + long + + + url + the url of the object store + string + + + false + + + createSecondaryStagingStore + create secondary staging store. + false + + + url + the URL for the staging store + true + string + + + details + the details for the staging store + false + map + map + + + provider + the staging store provider name + false + string + + + scope + the scope of the staging store: zone only for now + false + string + + + zoneid + the Zone ID for the staging store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + removeVmwareDc + Remove a Vmware datacenter from a zone. + false + + + zoneid + The id of Zone from which Vmware datacenter has to be removed. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateLBHealthCheckPolicy + Updates load balancer health check policy + true + 4.4 + + + id + ID of load balancer health check policy + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + removeTungstenFabricPolicyRule + remove Tungsten-Fabric policy + true + + + policyuuid + the Uuid of Tungsten-Fabric policy + true + string + + + ruleuuid + the Uuid of Tungsten-Fabric policy rule + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createLoadBalancerRule + Creates a load balancer rule + true + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + true + string + + + name + name of the load balancer rule + true + string + + + privateport + the private port of the private IP address/virtual machine where the network traffic will be load balanced to + true + integer + + + publicport + the public port from where the network traffic will be load balanced from + true + integer + + + account + the account associated with the load balancer. Must be used with the domainId parameter. + false + string + + + cidrlist + the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed. + false + list + 4.18.0.0 + list + + + description + the description of the load balancer rule + false + string + + + domainid + the domain ID associated with the load balancer + false + uuid + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + networkid + The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case) + false + uuid + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true + false + boolean + + + protocol + The protocol for the LB such as tcp, udp or tcp-proxy. + false + string + + + publicipid + public IP address ID from where the network traffic will be load balanced from + false + uuid + + + zoneid + zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm + false + uuid + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + importVsphereStoragePolicies + Import vSphere storage policies + false + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the Storage Policy + string + + + description + the description of the Storage Policy + string + + + name + the name of the Storage Policy + string + + + policyid + the identifier of the Storage Policy in vSphere DataCenter + string + + + zoneid + the ID of the Zone + string + + + false + + + disableOutOfBandManagementForZone + Disables out-of-band management for a zone + true + 4.9.0 + + + zoneid + the ID of the zone + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + createBackup + Create VM backup + true + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listIpv6FirewallRules + Lists all IPv6 firewall rules + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + boolean + + + id + Lists ipv6 firewall rule with the specified ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list ipv6 firewall rules by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + list ipv6 firewall rules by traffic type - ingress or egress + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteEgressFirewallRule + Deletes an egress firewall rule + true + + + id + the ID of the firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateVPC + Updates a VPC + true + + + id + the id of the VPC + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displaytext + the display text of the VPC + false + string + + + fordisplay + an optional field, whether to the display the vpc to the end user or not + false + 4.4 + boolean + + + name + the name of the VPC + false + string + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC + false + 4.19 + string + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + stopSystemVm + Stops a system VM. + true + + + id + The ID of the system virtual machine + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + listVMSchedule + List VM Schedules. + false + 4.19.0 + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + action + Action taken by schedule + false + string + + + enabled + ID of VM schedule + false + boolean + + + id + ID of VM schedule + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of VM schedule + string + + + action + Action + action + + + created + Date when the schedule was created + date + + + description + Description of VM schedule + string + + + enabled + VM schedule is enabled + boolean + + + enddate + Date after which the schedule becomes inactive + date + + + schedule + Cron formatted VM schedule + string + + + startdate + Date from which the schedule is active + date + + + timezone + Timezone of the schedule + string + + + virtualmachineid + ID of virtual machine + string + + + false + + + patchSystemVm + Attempts to live patch systemVMs - CPVM, SSVM + true + 4.17.0 + + + forced + If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only + false + boolean + + + id + patches systemVM - CPVM/SSVM with the specified ID + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVolumesMetrics + Lists volume metrics + false + 4.9.3 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster id the disk volume belongs to + false + uuid + + + diskofferingid + list volumes by disk offering + false + 4.4 + uuid + + + displayvolume + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hostid + list volumes on specified host + false + uuid + + + id + the ID of the disk volume + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id + false + list + 4.9 + list + + + isencrypted + list only volumes that are encrypted + false + 4.19.1 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + listsystemvms + list system VMs; only ROOT admin is eligible to pass this parameter + false + 4.18 + boolean + + + name + the name of the disk volume + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod id the disk volume belongs to + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + serviceofferingid + list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored + false + 4.19.1 + uuid + + + state + state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged. + false + string + + + storageid + the ID of the storage pool, available to ROOT admin only + false + 4.3 + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + type + the type of disk volume + false + string + + + virtualmachineid + the ID of the virtual machine + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + diskiopstotal + the total disk iops + long + + + sizegb + disk size in GiB + string + + + false + + + listSslCerts + Lists SSL certificates + false + + + accountid + Account ID + false + uuid + + + certid + ID of SSL certificate + false + uuid + + + lbruleid + Load balancer rule ID + false + uuid + + + projectid + Project that owns the SSL certificate + false + uuid + + + + + id + SSL certificate ID + string + + + account + account for the certificate + string + + + certchain + certificate chain + string + + + certificate + certificate + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + fingerprint + certificate fingerprint + string + + + loadbalancerrulelist + List of loabalancers this certificate is bound to + list + + + name + name + string + + + project + the project name of the certificate + string + + + projectid + the project id of the certificate + string + + + false + + + listDetailOptions + Lists all possible details and their options for a resource type such as a VM or a template + false + 4.13 + + + resourcetype + the resource type such as UserVm, Template etc. + true + string + + + resourceid + the UUID of the resource (optional) + false + string + + + + + details + Map of all possible details and their possible list of values + map + + + false + + + listPrivateGateways + List private gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list private gateway by id + false + uuid + + + ipaddress + list gateways by ip address + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + list gateways by state + false + string + + + vlan + list gateways by vlan + false + string + + + vpcid + list gateways by vpc + false + uuid + + + + + id + the id of the private gateway + string + + + account + the account associated with the private gateway + string + + + aclid + ACL Id set for private gateway + string + + + aclname + ACL name set for private gateway + string + + + domain + the domain associated with the private gateway + string + + + domainid + the ID of the domain associated with the private gateway + string + + + domainpath + path of the domain to which the private gateway belongs + 4.19.2.0 + string + + + gateway + the gateway + string + + + ipaddress + the private gateway's ip address + string + + + netmask + the private gateway's netmask + string + + + physicalnetworkid + the physical network id + string + + + project + the project name of the private gateway + string + + + projectid + the project id of the private gateway + string + + + sourcenatsupported + Source Nat enable status + boolean + + + state + State of the gateway, can be Creating, Ready, Deleting + string + + + vlan + the network implementation uri for the private gateway + string + + + vpcid + VPC id the private gateway belongs to + string + + + vpcname + VPC name the private gateway belongs to + 4.13.2 + string + + + zoneid + zone id of the private gateway + string + + + zonename + the name of the zone the private gateway belongs to + string + + + false + + + updateVmNicIp + Update the default Ip of a VM Nic + true + + + nicid + the ID of the nic to which you want to assign private IP + true + uuid + + + ipaddress + Secondary IP Address + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + startInternalLoadBalancerVM + Starts an existing internal lb vm. + true + + + id + the ID of the internal lb vm + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateDiskOffering + Updates a disk offering. + false + + + id + ID of the disk offering + true + uuid + + + bytesreadrate + bytes read rate of the disk offering + false + 4.15 + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + 4.15 + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + byteswriterate + bytes write rate of the disk offering + false + 4.15 + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + 4.15 + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + cachemode + the cache mode to use for this disk offering + false + 4.15 + string + + + displayoffering + an optional field, whether to display the offering to the end user or not. + false + boolean + + + displaytext + updates alternate display text of the disk offering with this value + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + 4.13 + string + + + iopsreadrate + io requests read rate of the disk offering + false + 4.15 + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + 4.15 + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + iopswriterate + io requests write rate of the disk offering + false + 4.15 + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + 4.15 + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + name + updates name of the disk offering with this value + false + string + + + sortkey + sort key of the disk offering, integer + false + integer + + + state + state of the disk offering + false + string + + + tags + comma-separated list of tags for the disk offering, tags should match with existing storage pool tags + false + 4.15 + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + state + state of the disk offering + string + + + storagetype + the storage type for this disk offering + string + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + removeVirtualMachinesFromKubernetesCluster + Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters. + false + 4.19.0 + + + id + the ID of the Kubernetes cluster + true + uuid + + + virtualmachineids + the IDs of the VMs to remove from the cluster + true + list + list + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the Kubernetes cluster + string + + + false + + + deleteTungstenFabricLogicalRouter + delete Tungsten-Fabric logical router + true + + + logicalrouteruuid + the uuid of Tungsten-Fabric logical router + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + resetVpnConnection + Reset site to site vpn connection + true + + + id + id of vpn connection + true + uuid + + + account + an optional account for connection. Must be used with domainId. + false + string + + + domainid + an optional domainId for connection. If the account parameter is used, domainId must also be used. + false + uuid + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + listKubernetesClusters + Lists Kubernetes clusters + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged + false + 4.19.0 + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the Kubernetes cluster + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned) + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + state of the Kubernetes cluster + false + string + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + createAutoScaleVmGroup + Creates and automatically starts a virtual machine based on a service offering, disk offering, and template. + true + + + lbruleid + the ID of the load balancer rule + true + uuid + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + true + integer + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + true + integer + + + scaledownpolicyids + list of scaledown autoscale policies + true + list + list + + + scaleuppolicyids + list of scaleup autoscale policies + true + list + list + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + true + uuid + + + fordisplay + an optional field, whether to the display the group to the end user or not + false + 4.4 + boolean + + + interval + the frequency in which the performance counters to be collected + false + integer + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + addBaremetalPxePingServer + add a baremetal ping pxe server + true + + + password + Credentials to reach external pxe device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + pingdir + Root directory on PING storage server + true + string + + + pingstorageserverip + PING storage server ip + true + string + + + pxeservertype + type of pxe device + true + string + + + tftpdir + Tftp root directory of PXE server + true + string + + + url + URL of the external pxe device + true + string + + + username + Credentials to reach external pxe device + true + string + + + pingcifspassword + Password of PING storage server + false + string + + + pingcifsusername + Username of PING storage server + false + string + + + podid + Pod Id + false + uuid + + + + + pingdir + Root directory on PING storage server + string + + + pingstorageserverip + PING storage server ip + string + + + tftpdir + Tftp root directory of PXE server + string + + + false + + + deleteLoadBalancerRule + Deletes a load balancer rule. + true + + + id + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listPortableIpRanges + list portable IP ranges + false + + + id + Id of the portable ip range + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + regionid + Id of a Region + false + integer + + + + + id + portable IP range ID + string + + + endip + the end ip of the portable IP range + string + + + gateway + the gateway of the VLAN IP range + string + + + netmask + the netmask of the VLAN IP range + string + + + regionid + Region Id in which portable ip range is provisioned + integer + + + startip + the start ip of the portable IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + portableipaddress(*) + List of portable IP and association with zone/network/vpc details that are part of GSLB rule + + + accountid + the account ID the portable IP address is associated with + string + + + allocated + date the portal IP address was acquired + date + + + domainid + the domain ID the portable IP address is associated with + string + + + ipaddress + public IP address + string + + + networkid + the ID of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + regionid + Region Id in which global load balancer is created + integer + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing and Free + string + + + vpcid + VPC the ip belongs to + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + list + + + false + + + getVirtualMachineUserData + Returns user data associated with the VM + false + 4.4 + + + virtualmachineid + The ID of the virtual machine + true + uuid + + + + + userdata + Base64 encoded VM user data + string + + + virtualmachineid + the ID of the virtual machine + string + + + false + + + createNetworkPermissions + Updates network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + accountids + a comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + accounts + a comma delimited list of accounts within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + projectids + a comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addIpToNic + Assigns secondary IP to NIC + true + + + nicid + the ID of the nic to which you want to assign private IP + true + uuid + + + ipaddress + Secondary IP Address + false + string + + + + + id + the ID of the secondary private IP addr + string + + + ipaddress + Secondary IP address + string + + + networkid + the ID of the network + string + + + nicid + the ID of the nic + string + + + secondaryip + the list of Secondary ipv4 addr of nic + list + + + virtualmachineid + the ID of the vm + string + + + false + + + quotaTariffUpdate + Update the tariff plan for a resource + false + 4.7.0 + + + name + Quota tariff's name + true + 4.18.0.0 + string + + + activationrule + Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule. + false + 4.18.0.0 + string + + + description + Quota tariff's description. Inform empty to remove the description. + false + 4.18.0.0 + string + + + enddate + The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2009-06-03. + false + 4.18.0.0 + date + + + startdate + DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + usagetype + DEPRECATED. Integer value for the usage type of the resource + false + integer + + + value + The quota tariff value of the resource as per the default unit. + false + double + + + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + uuid + uuid + string + + + false + + + disableStaticNat + Disables static rule for given IP address + true + + + ipaddressid + the public IP address ID for which static NAT feature is being disabled + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteUcsManager + Delete a Ucs manager + false + + + ucsmanagerid + ucs manager id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteHost + Deletes a host. + false + + + id + the host ID + true + uuid + + + forced + Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped + false + boolean + + + forcedestroylocalstorage + Force destroy local storage on this host. All VMs created on this local storage will be destroyed + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteResourceIcon + deletes the resource icon from the specified resource(s) + false + 4.16.0.0 + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listCapabilities + Lists capabilities + false + + + + allowusercreateprojects + true if regular user is allowed to create projects + boolean + + + allowuserexpungerecovervm + true if the user can recover and expunge virtualmachines, false otherwise + 4.6.0 + boolean + + + allowuserexpungerecovervolume + true if the user can recover and expunge volumes, false otherwise + 4.14.0 + boolean + + + allowuserviewalldomainaccounts + true if users can see all accounts within the same domain, false otherwise + boolean + + + allowuserviewdestroyedvm + true if the user is allowed to view destroyed virtualmachines, false otherwise + 4.6.0 + boolean + + + apilimitinterval + time interval (in seconds) to reset api count + integer + + + apilimitmax + Max allowed number of api requests within the specified interval + integer + + + cloudstackversion + version of the cloud stack + string + + + customdiskofferingmaxsize + maximum size that can be specified when create disk from disk offering with custom size + long + + + customdiskofferingminsize + minimum size that can be specified when create disk from disk offering with custom size + long + + + customhypervisordisplayname + Display name for custom hypervisor + 4.19.0 + string + + + defaultuipagesize + default page size in the UI for various views, value set in the configurations + 4.15.2 + long + + + dynamicrolesenabled + true if dynamic role-based api checker is enabled, false otherwise + boolean + + + instancesdisksstatsretentionenabled + true if stats are retained for instance disks otherwise false + 4.18.0 + boolean + + + instancesdisksstatsretentiontime + the retention time for Instances disks stats + 4.18.0 + integer + + + instancesstatsretentiontime + the retention time for Instances stats + 4.18.0 + integer + + + instancesstatsuseronly + true if stats are collected only for user instances, false if system instance stats are also collected + 4.18.0 + boolean + + + kubernetesclusterexperimentalfeaturesenabled + true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise + boolean + + + kubernetesserviceenabled + true if Kubernetes Service plugin is enabled, false otherwise + boolean + + + kvmsnapshotenabled + true if snapshot is supported for KVM host, false otherwise + boolean + + + projectinviterequired + If invitation confirmation is required when add account to project + boolean + + + regionsecondaryenabled + true if region wide secondary is enabled, false otherwise + boolean + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + supportELB + true if region supports elastic load balancer on basic zones + string + + + userpublictemplateenabled + true if user and domain admins can set templates to be shared, false otherwise + boolean + + + false + + + releaseDedicatedZone + Release dedication of zone + true + + + zoneid + the ID of the Zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateNetworkServiceProvider + Updates a network serviceProvider of a physical network + true + 3.0.0 + + + id + network service provider id + true + uuid + + + servicelist + the list of services to be enabled for this physical network service provider + false + list + list + + + state + Enabled/Disabled/Shutdown the physical network service provider + false + string + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + checkVolume + Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only + true + 4.19.1 + + + id + The ID of the volume + true + uuid + + + repair + parameter to repair the volume, leaks or all are the possible values + false + string + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listManagementServersMetrics + Lists Management Server metrics + false + 4.17.0 + + + id + the id of the management server + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the management server + false + string + + + page + false + integer + + + pagesize + false + integer + + + system + include system level stats + false + boolean + + + + + agentcount + the number of agents this Management Server is responsible for + integer + + + availableprocessors + the number of processors available to the JVM + integer + + + collectiontime + the time these statistics were collected + date + + + cpuload + the current cpu load + string + + + dbislocal + the system is running against a local database + boolean + + + heapmemorytotal + the amount of memory allocated to this Management Server + long + + + heapmemoryused + the amount of memory used by this Management Server + long + + + loginfo + the log files and their usage on disk + string + + + sessions + the number of client sessions active on this Management Server + long + + + systemcycleusage + the system load for user, and system processes and the system idle cycles + long[] + + + systemloadaverages + the load averages for 1 5 and 15 minutes + double[] + + + systemmemoryfree + Free system memory + string + + + systemmemorytotal + Total system memory + string + + + systemmemoryused + Amount of memory used + string + + + systemmemoryvirtualsize + Virtual size of the fully loaded process + string + + + systemtotalcpucycles + the total system cpu capacity + double + + + threadsblockedcount + The number of blocked threads + integer + + + threadsdaemoncount + The number of daemon threads + integer + + + threadsrunnablecount + The number of runnable threads + integer + + + threadsteminatedcount + The number of terminated threads + integer + + + threadstotalcount + The number of threads + integer + + + threadswaitingcount + The number of waiting threads + integer + + + usageislocal + the system has a usage server running locally + boolean + + + false + + + listInstanceGroups + Lists vm groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list instance groups by ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list instance groups by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + domainpath + path of the Domain the instance group belongs to + 4.19.2.0 + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + removeFromLoadBalancerRule + Removes a virtual machine or a list of virtual machines from a load balancer rule. + true + + + id + The ID of the load balancer rule + true + uuid + + + virtualmachineids + the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3) + false + list + list + + + vmidipmap + VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75 + false + map + 4.4 + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createStaticRoute + Creates a static route + true + + + cidr + static route cidr + true + string + + + gatewayid + the gateway id we are creating static route for + true + uuid + + + + + id + the ID of static route + string + + + account + the account associated with the static route + string + + + cidr + static route CIDR + string + + + domain + the domain associated with the static route + string + + + domainid + the ID of the domain associated with the static route + string + + + domainpath + the domain path associated with the static route + 4.19.2.0 + string + + + gatewayid + VPC gateway the route is created for + string + + + project + the project name of the static route + string + + + projectid + the project id of the static route + string + + + state + the state of the static route + string + + + vpcid + VPC the static route belongs to + string + + + tags(*) + the list of resource tags associated with static route + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deletePrivateGateway + Deletes a Private gateway + true + + + id + the ID of the private gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateDomain + Updates a domain with a new name + false + + + id + ID of domain to update + true + uuid + + + name + updates domain with this name + false + string + + + networkdomain + Network domain for the domain's networks; empty string will update domainName with NULL value + false + string + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + disableAutoScaleVmGroup + Disables an AutoScale Vm Group + true + + + id + the ID of the autoscale group + true + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + createSnapshotPolicy + Creates a snapshot policy for the account. + false + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + maxsnaps + maximum number of snapshots to retain + true + integer + + + schedule + time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + true + string + + + volumeid + the ID of the disk volume + true + uuid + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + tags + Map of tags (key/value pairs) + false + map + map + + + zoneids + A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present. + false + list + list + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + zone + The list of zones in which snapshot backup is scheduled + 4.19.0 + set + + + false + + + disableHAForZone + Disables HA for a zone + true + 4.11 + + + zoneid + ID of the zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + unmanageVolume + Unmanage a volume on storage pool. + true + 4.19.1 + + + id + The ID of the volume to unmanage + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createRolePermission + Adds an API permission to a role + false + 4.9.0 + + + permission + The rule permission, allow or deny. Default: deny. + true + string + + + roleid + ID of the role + true + uuid + + + rule + The API name or wildcard rule such as list* + true + string + + + description + The description of the role permission + false + string + + + + + id + the ID of the role permission + string + + + roleid + the ID of the role to which the role permission belongs + string + + + rolename + the name of the role to which the role permission belongs + string + + + false + + + listSystemVms + List system virtual machines. + false + + + hostid + the host ID of the system VM + false + uuid + + + id + the ID of the system VM + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the system VM + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the system VM + false + uuid + + + state + the state of the system VM + false + string + + + storageid + the storage ID where vm's volumes belong to + false + 3.0.1 + uuid + + + systemvmtype + the system VM type. Possible types are "consoleproxy" and "secondarystoragevm". + false + string + + + zoneid + the Zone ID of the system VM + false + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + detachVolume + Detaches a disk volume from a virtual machine. + true + + + deviceid + the device ID on the virtual machine where volume is detached from + false + long + + + id + the ID of the disk volume + false + uuid + + + virtualmachineid + the ID of the virtual machine where the volume is detached from + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + replaceNetworkACLList + Replaces ACL associated with a network or private gateway + true + + + aclid + the ID of the network ACL + true + uuid + + + gatewayid + the ID of the private gateway + false + uuid + + + networkid + the ID of the network + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricAddressGroup + list Tungsten-Fabric address group + false + + + addressgroupuuid + the uuid of Tungsten-Fabric address group + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + ipprefix + Tungsten-Fabric address group ip prefix + string + + + ipprefixlen + Tungsten-Fabric address group ip prefix length + int + + + name + Tungsten-Fabric address group name + string + + + uuid + Tungsten-Fabric address group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listLdapUsers + Lists LDAP Users according to the specifications from the user request. + false + 4.2.0 + + + domainid + linked domain + false + uuid + + + keyword + List by keyword + false + string + + + listtype + Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter + false + string + + + page + false + integer + + + pagesize + false + integer + + + userfilter + Determines what type of filter is applied on the list of users returned from LDAP. + valid values are + 'NoFilter' no filtering is done, + 'LocalDomain' users already in the current or requested domain will be filtered out of the result list, + 'AnyDomain' users that already exist anywhere in cloudstack will be filtered out, and + 'PotentialImport' all users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource + false + 4.13 + string + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + enableOutOfBandManagementForZone + Enables out-of-band management for a zone + true + 4.9.0 + + + zoneid + the ID of the zone + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + createVMSchedule + Create VM Schedule + false + 4.19.0 + + + action + Action to take on the VM (start/stop/restart/force_stop/force_reboot). + true + string + + + schedule + Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month' + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + description + Description of the schedule + false + string + + + enabled + Enable VM schedule. Defaults to true + false + boolean + + + enddate + end date after which the schedule becomes inactiveUse format "yyyy-MM-dd hh:mm:ss") + false + date + + + startdate + start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of VM schedule + string + + + action + Action + action + + + created + Date when the schedule was created + date + + + description + Description of VM schedule + string + + + enabled + VM schedule is enabled + boolean + + + enddate + Date after which the schedule becomes inactive + date + + + schedule + Cron formatted VM schedule + string + + + startdate + Date from which the schedule is active + date + + + timezone + Timezone of the schedule + string + + + virtualmachineid + ID of virtual machine + string + + + false + + + listIpForwardingRules + List the IP forwarding rules + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + list the rule belonging to this public IP address + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + virtualmachineid + Lists all rules applied to the specified VM. + false + uuid + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createSnapshot + Creates an instant snapshot of a volume. + true + + + volumeid + The ID of the disk volume + true + uuid + + + account + The account of the snapshot. The account parameter must be used with the domainId parameter. + false + string + + + asyncbackup + asynchronous backup if true + false + boolean + + + domainid + The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain. + false + uuid + + + locationtype + Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'. + false + string + + + name + the name of the snapshot + false + string + + + policyid + policy id of the snapshot, if this is null, then use MANUAL_POLICY. + false + uuid + + + quiescevm + quiesce vm if true + false + boolean + + + tags + Map of tags (key/value pairs) + false + map + map + + + zoneids + A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. + false + list + 4.19.0 + list + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listStoragePoolsMetrics + Lists storage pool metrics + false + 4.9.3 + + + clusterid + list storage pools belongig to the specific cluster + false + uuid + + + hostid + host ID of the storage pools + false + uuid + + + id + the ID of the storage pool + false + uuid + + + ipaddress + the IP address for the storage pool + false + string + + + keyword + List by keyword + false + string + + + name + the name of the storage pool + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the storage pool path + false + string + + + podid + the Pod ID for the storage pool + false + uuid + + + scope + the scope of the storage pool + false + string + + + status + the status of the storage pool + false + string + + + storagecustomstats + If true, lists the custom stats of the storage pool + false + 4.18.1 + boolean + + + zoneid + the Zone ID for the storage pool + false + uuid + + + + + disksizeallocatedgb + disk size allocated in GiB + string + + + disksizetotalgb + disk size in GiB + string + + + disksizeunallocatedgb + disk size unallocated in GiB + string + + + disksizeusedgb + disk size used in GiB + string + + + storageallocateddisablethreshold + storage allocated disable threshold exceeded + boolean + + + storageallocatedthreshold + storage allocated notification threshold exceeded + boolean + + + storageusagedisablethreshold + storage usage disable threshold exceeded + boolean + + + storageusagethreshold + storage usage notification threshold exceeded + boolean + + + false + + + createSSHKeyPair + Create a new keypair and returns the private key + false + + + name + Name of the keypair + true + string + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the ssh key. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the ssh key + false + uuid + + + + + privatekey + Private key + string + + + false + + + deleteBackupOffering + Deletes a backup offering + false + 4.14.0 + + + id + ID of the backup offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricServiceGroup + list Tungsten-Fabric service group + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + servicegroupuuid + the uuid of Tungsten-Fabric service group + false + string + + + zoneid + the ID of zone + false + uuid + + + + + endport + Tungsten-Fabric service group end port + int + + + name + Tungsten-Fabric service group name + string + + + protocol + Tungsten-Fabric service group protocol + string + + + startport + Tungsten-Fabric service group start port + int + + + uuid + Tungsten-Fabric service group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + authorizeSecurityGroupEgress + Authorizes a particular egress rule for this security group + true + 3.0.0 + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + cidrlist + the cidr list associated. Multiple entries must be separated by a single comma character (,). + false + list + list + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + endport + end port for this egress rule + false + integer + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + projectid + an optional project of the security group + false + uuid + + + protocol + TCP is default. UDP is the other supported protocol + false + string + + + securitygroupid + The ID of the security group. Mutually exclusive with securityGroupName parameter + false + uuid + + + securitygroupname + The name of the security group. Mutually exclusive with securityGroupId parameter + false + string + + + startport + start port for this egress rule + false + integer + + + usersecuritygrouplist + user to security group mapping + false + map + map + + + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listStoragePools + Lists storage pools. + false + + + clusterid + list storage pools belongig to the specific cluster + false + uuid + + + hostid + host ID of the storage pools + false + uuid + + + id + the ID of the storage pool + false + uuid + + + ipaddress + the IP address for the storage pool + false + string + + + keyword + List by keyword + false + string + + + name + the name of the storage pool + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the storage pool path + false + string + + + podid + the Pod ID for the storage pool + false + uuid + + + scope + the scope of the storage pool + false + string + + + status + the status of the storage pool + false + string + + + storagecustomstats + If true, lists the custom stats of the storage pool + false + 4.18.1 + boolean + + + zoneid + the Zone ID for the storage pool + false + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + enableCiscoNexusVSM + Enable a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be enabled + true + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + findHostsForMigration + Find hosts suitable for migrating a virtual machine. + false + + + virtualmachineid + find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + requiresStorageMotion + true if migrating a vm to this host requires storage motion, false otherwise + boolean + + + false + + + updateHypervisorCapabilities + Updates a hypervisor capabilities. + false + 3.0.0 + + + hypervisor + the hypervisor for which the hypervisor capabilities are to be updated + false + 4.19.1 + string + + + hypervisorversion + the hypervisor version for which the hypervisor capabilities are to be updated + false + 4.19.1 + string + + + id + ID of the hypervisor capability + false + uuid + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached to a VM for this hypervisor. + false + 4.16.0 + integer + + + maxguestslimit + the max number of Guest VMs per host for this hypervisor. + false + long + + + maxhostspercluster + the maximum number of the hypervisor hosts per cluster + false + 4.16.0 + integer + + + securitygroupenabled + set true to enable security group for this hypervisor. + false + boolean + + + storagemotionenabled + set true to enable storage motion support for this hypervisor + false + 4.16.0 + boolean + + + vmsnapshotenabled + set true to enable VM snapshots for this hypervisor + false + 4.16.0 + boolean + + + + + id + the ID of the hypervisor capabilities row + string + + + hypervisor + the hypervisor type + string + + + hypervisorversion + the hypervisor version + string + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached for this hypervisor + integer + + + maxguestslimit + the maximum number of guest vms recommended for this hypervisor + long + + + maxhostspercluster + the maximum number of Hosts per cluster for this hypervisor + integer + + + securitygroupenabled + true if security group is supported + boolean + + + storagemotionenabled + true if storage motion is supported + boolean + + + vmsnapshotenabled + true if VM snapshots are enabled for this hypervisor + boolean + + + false + + + isAccountAllowedToCreateOfferingsWithTags + Return true if the specified account is allowed to create offerings with tags. + false + + + id + Account UUID + false + uuid + + + + + isallowed + is domain admin allowed to create offerings with tags + boolean + + + false + + + addNicToVirtualMachine + Adds VM to specified network by creating a NIC + true + + + networkid + Network ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + dhcpoptions + DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com + false + map + map + + + ipaddress + IP Address for the new network + false + string + + + macaddress + Mac Address for the new network + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + getSPMetadata + Returns SAML2 CloudStack Service Provider MetaData + false + + + + metadata + The Metadata XML + string + + + false + + + listStaticRoutes + Lists all static routes + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + gatewayid + list static routes by gateway id + false + uuid + + + id + list static route by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + list static routes by state + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vpcid + list static routes by vpc id + false + uuid + + + + + id + the ID of static route + string + + + account + the account associated with the static route + string + + + cidr + static route CIDR + string + + + domain + the domain associated with the static route + string + + + domainid + the ID of the domain associated with the static route + string + + + domainpath + the domain path associated with the static route + 4.19.2.0 + string + + + gatewayid + VPC gateway the route is created for + string + + + project + the project name of the static route + string + + + projectid + the project id of the static route + string + + + state + the state of the static route + string + + + vpcid + VPC the static route belongs to + string + + + tags(*) + the list of resource tags associated with static route + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listPublicIpAddresses + Lists all public ip addresses + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + allocatedonly + limits search results to allocated public IP addresses + false + boolean + + + associatednetworkid + lists all public IP addresses associated to the network specified + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + forloadbalancing + list only IPs used for load balancing + false + boolean + + + forvirtualnetwork + the virtual network for the IP address + false + boolean + + + id + lists IP address by ID + false + uuid + + + ipaddress + lists the specified IP address + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issourcenat + list only source NAT IP addresses + false + boolean + + + isstaticnat + list only static NAT IP addresses + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + lists all public IP addresses by source network ID + false + 4.13.0 + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + lists all public IP addresses by physical network ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + state + lists all public IP addresses by state + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vlanid + lists all public IP addresses by VLAN ID + false + uuid + + + vpcid + List IPs belonging to the VPC + false + uuid + + + zoneid + lists all public IP addresses by zone ID + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listOpenDaylightControllers + Lists OpenDyalight controllers + false + + + id + the ID of a OpenDaylight Controller + false + uuid + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + addBigSwitchBcfDevice + Adds a BigSwitch BCF Controller device + true + 4.6.0 + + + hostname + Hostname of ip address of the BigSwitch BCF Controller. + true + string + + + nat + NAT support of the BigSwitch BCF Controller. + true + boolean + + + password + Password of the BigSwitch BCF Controller. + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Username of the BigSwitch BCF Controller. + true + string + + + + + bcfdeviceid + device id of the BigSwitch BCF Controller + string + + + bigswitchdevicename + device name + string + + + hostname + the controller Ip address + string + + + nat + NAT support + boolean + + + password + the controller password + string + + + physicalnetworkid + the physical network to which this BigSwitch BCF segment belongs to + string + + + provider + name of the provider + string + + + username + the controller username + string + + + false + + + updateDefaultNicForVirtualMachine + Changes the default NIC on a VM + true + + + nicid + NIC ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + generateClusterDrsPlan + Generate DRS plan for a cluster + false + 4.19.0 + + + id + the ID of the Cluster + true + uuid + + + migrations + Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting + false + integer + + + + + id + unique ID of the drs plan for cluster + string + + + clusterid + Id of the cluster + string + + + eventid + Start event Id of the DRS Plan + string + + + migrations + List of migrations + list + + + status + Status of DRS Plan + status + + + type + Type of DRS Plan (Automated or Manual)) + type + + + false + + + issueOutOfBandManagementPowerAction + Initiates the specified power action to the host's out-of-band management interface + true + 4.9.0 + + + action + out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS + true + string + + + hostid + the ID of the host + true + uuid + + + timeout + optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting + false + long + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + deleteUser + Deletes a user for an account + false + + + id + id of the user to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkDevice + Deletes network device. + false + + + id + Id of network device to delete + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateImageStore + Updates image store read-only status + false + 4.15.0 + + + id + Image Store UUID + true + uuid + + + capacitybytes + The number of bytes CloudStack can use on this image storage. + NOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage. + false + long + + + name + The new name for the Image Store. + false + string + + + readonly + If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration + false + boolean + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + assignToLoadBalancerRule + Assigns virtual machine or a list of virtual machines to a load balancer rule. + true + + + id + the ID of the load balancer rule + true + uuid + + + virtualmachineids + the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3) + false + list + list + + + vmidipmap + VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75 + false + map + 4.4 + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAsyncJobs + Lists all pending asynchronous jobs for the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + managementserverid + The id of the management server + false + 4.19 + uuid + + + page + false + integer + + + pagesize + false + integer + + + startdate + The start date of the async job (use format "yyyy-MM-dd'T'HH:mm:ss'+'SSSS") + false + date + + + + + account + the account that executed the async command + string + + + accountid + the account id that executed the async command + string + + + cmd + the async command executed + string + + + completed + the completed date of the job + date + + + created + the created date of the job + date + + + domainid + the domain id that executed the async command + string + + + domainpath + the domain that executed the async command + string + + + jobinstanceid + the unique ID of the instance/entity object related to the job + string + + + jobinstancetype + the instance/entity object related to the job + string + + + jobprocstatus + the progress information of the PENDING job + integer + + + jobresult + the result reason + responseobject + + + jobresultcode + the result code for the job + integer + + + jobresulttype + the result type + string + + + jobstatus + the current job status-should be 0 for PENDING + integer + + + managementserverid + the msid of the management server on which the job is running + 4.19 + long + + + userid + the user that executed the async command + string + + + jobid + the ID of the async job + + + false + + + archiveAlerts + Archive one or more alerts. + false + + + enddate + end date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the alerts + false + list + list + + + startdate + start date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + archive by alert type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteCiscoVnmcResource + Deletes a Cisco Vnmc controller + false + + + resourceid + Cisco Vnmc resource ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createSecondaryStorageSelector + Creates a secondary storage selector, described by the heuristic rule. + false + 4.19.0 + + + description + The description of the heuristic rule. + true + string + + + heuristicrule + The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID. + true + string + + + name + The name identifying the heuristic rule. + true + string + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + true + string + + + zoneid + The zone in which the heuristic rule will be applied. + true + uuid + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + addBrocadeVcsDevice + Adds a Brocade VCS Switch + true + + + hostname + Hostname of ip address of the Brocade VCS Switch. + true + string + + + password + Credentials to access the Brocade VCS Switch API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Credentials to access the Brocade VCS Switch API + true + string + + + + + brocadedevicename + device name + string + + + hostname + the principal switch Ip address + string + + + physicalnetworkid + the physical Network to which this Brocade VCS belongs to + string + + + provider + name of the provider + string + + + vcsdeviceid + device id of the Brocade Vcs + string + + + false + + + deleteTags + Deleting resource tag(s) + true + 4.0.0 + + + resourceids + Delete tags for resource id(s) + true + list + list + + + resourcetype + Delete tag by resource type + true + string + + + tags + Delete tags matching key/value pairs + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricTagType + create Tungsten-Fabric tag type + true + + + name + Tungsten-Fabric tag type name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric tag type name + string + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + login + Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired. + false + + + password + Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Username + true + string + + + domain + Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed. + false + string + + + domainId + The id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precedence. + false + long + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + restartNetwork + Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules + true + + + id + The ID of the network to restart. + true + uuid + + + cleanup + If cleanup old network elements + false + boolean + + + livepatch + Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false. + false + 4.17.0 + boolean + + + makeredundant + Turn the network into a network with redundant routers. + false + 4.11.1 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listHypervisorCapabilities + Lists all hypervisor capabilities. + false + 3.0.0 + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + ID of the hypervisor capability + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the hypervisor capabilities row + string + + + hypervisor + the hypervisor type + string + + + hypervisorversion + the hypervisor version + string + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached for this hypervisor + integer + + + maxguestslimit + the maximum number of guest vms recommended for this hypervisor + long + + + maxhostspercluster + the maximum number of Hosts per cluster for this hypervisor + integer + + + securitygroupenabled + true if security group is supported + boolean + + + storagemotionenabled + true if storage motion is supported + boolean + + + vmsnapshotenabled + true if VM snapshots are enabled for this hypervisor + boolean + + + false + + + deleteProjectRole + Delete Project roles in CloudStack + false + 4.15.0 + + + id + ID of the project role to be deleted + true + uuid + + + projectid + ID of the project from where the role is to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getSolidFireAccountId + Get SolidFire Account ID + false + + + accountid + CloudStack Account UUID + true + string + + + storageid + Storage Pool UUID + true + string + + + + + solidFireAccountId + SolidFire Account ID + long + + + false + + + quotaBalance + Create a quota balance statement + false + 4.7.0 + + + account + Account Id for which statement needs to be generated + true + string + + + domainid + If domain Id is given and the caller is domain admin then the statement is generated for domain. + true + uuid + + + accountid + List usage records for the specified account + false + uuid + + + enddate + End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + startdate + Start date range quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + false + date + + + + + account + account name + string + + + accountid + account id + long + + + domain + domain id + long + + + name + usage type name + string + + + quota + quota consumed + bigdecimal + + + type + usage type + int + + + unit + usage unit + string + + + false + + + listRolePermissions + Lists role permissions + false + 4.9.0 + + + roleid + ID of the role + false + uuid + + + + + id + the ID of the role permission + string + + + roleid + the ID of the role to which the role permission belongs + string + + + rolename + the name of the role to which the role permission belongs + string + + + false + + + listDedicatedGuestVlanRanges + Lists dedicated guest vlan ranges + false + + + account + the account with which the guest VLAN range is associated. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain. + false + uuid + + + guestvlanrange + the dedicated guest vlan range + false + string + + + id + list dedicated guest vlan ranges by id + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + physical network id of the guest VLAN range + false + uuid + + + projectid + project who will own the guest VLAN range + false + uuid + + + zoneid + zone of the guest VLAN range + false + uuid + + + + + id + the ID of the guest VLAN range + string + + + account + the account of the guest VLAN range + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + domainpath + path of the domain to which the guest VLAN range belongs + 4.19.2.0 + string + + + guestvlanrange + the guest VLAN range + string + + + physicalnetworkid + the physical network of the guest vlan range + long + + + project + the project name of the guest vlan range + string + + + projectid + the project id of the guest vlan range + string + + + zoneid + the zone of the guest vlan range + long + + + false + + + listNetworkACLs + Lists all network ACL items + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + aclid + list network ACL items by ACL ID + false + uuid + + + action + list network ACL items by action + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists network ACL Item with the specified ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list network ACL items by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + protocol + list network ACL items by protocol + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + list network ACL items by traffic type - ingress or egress + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + copyTemplate + Copies a template from one zone to another. + true + + + id + Template ID. + true + uuid + + + destzoneid + ID of the zone the template is being copied to. + false + uuid + + + destzoneids + 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. + false + list + list + + + sourcezoneid + 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. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listNiciraNvpDeviceNetworks + lists network that are using a nicira nvp device + false + + + nvpdeviceid + nicira nvp device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteBigSwitchBcfDevice + delete a BigSwitch BCF Controller device + true + 4.6.0 + + + bcfdeviceid + BigSwitch device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listOvsElements + Lists all available ovs elements. + false + + + enabled + list network offerings by enabled state + false + boolean + + + id + list ovs elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list ovs elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the ovs + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + associateUcsProfileToBlade + associate a profile to a blade + true + + + bladeid + blade id + true + uuid + + + profiledn + profile dn + true + string + + + ucsmanagerid + ucs manager id + true + uuid + + + + + id + ucs blade id + string + + + bladedn + ucs blade dn + string + + + hostid + cloudstack host id this blade associates to + string + + + profiledn + associated ucs profile dn + string + + + ucsmanagerid + ucs manager id + string + + + false + + + validateUserTwoFactorAuthenticationCode + Checks the 2FA code for the user. + false + 4.18.0 + + + codefor2fa + two factor authentication code + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateVmwareDc + Updates a Vmware datacenter details for a zone + false + 4.12.0 + + + zoneid + The zone ID + true + uuid + + + isrecursive + Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true. + false + boolean + + + name + Vmware datacenter name. + false + string + + + password + The password for specified username. + false + string + + + username + The username required to connect to resource. + false + string + + + vcenter + The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + listNetscalerControlCenter + list control center + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + id + string + + + ipaddress + ncc_ip + string + + + numretries + num_retries + string + + + username + username + string + + + uuid + uuid + string + + + false + + + getRouterHealthCheckResults + Starts a router. + false + 4.14.0 + + + routerid + the ID of the router + true + uuid + + + performfreshchecks + if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched + false + boolean + + + + + healthchecks + the id of the router + list + + + routerid + the id of the router + string + + + false + + + resizeVolume + Resizes a volume + true + + + id + the ID of the disk volume + true + uuid + + + diskofferingid + new disk offering id + false + uuid + + + maxiops + New maximum number of IOPS + false + long + + + miniops + New minimum number of IOPS + false + long + + + shrinkok + Verify OK to Shrink + false + boolean + + + size + New volume size in GB + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteAffinityGroup + Deletes affinity group + true + + + account + the account of the affinity group. Must be specified with domain ID + false + string + + + domainid + the domain ID of account owning the affinity group + false + uuid + + + id + The ID of the affinity group. Mutually exclusive with name parameter + false + uuid + + + name + The name of the affinity group. Mutually exclusive with ID parameter + false + string + + + projectid + the project of the affinity group + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkOffering + Deletes a network offering. + false + 3.0.0 + + + id + the ID of the network offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateStorageNetworkIpRange + Update a Storage network IP range, only allowed when no IPs in this range have been allocated. + true + 3.0.0 + + + id + UUID of storage network ip range + true + uuid + + + endip + the ending IP address + false + string + + + netmask + the netmask for storage network + false + string + + + startip + the beginning IP address + false + string + + + vlan + Optional. the vlan the ip range sits on + false + integer + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + dedicatePod + Dedicates a Pod. + true + + + domainid + the ID of the containing domain + true + uuid + + + podid + the ID of the Pod + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Pod is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the pod + string + + + domainid + the domain ID to which the Pod is dedicated + string + + + podid + the ID of the Pod + string + + + podname + the Name of the Pod + string + + + false + + + synchronizeTungstenFabricData + Synchronize Tungsten-Fabric data + false + + + id + provider id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + changeOfferingForVolume + Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering + true + 4.17 + + + id + the ID of the volume + true + uuid + + + diskofferingid + new disk offering id + true + uuid + + + automigrate + Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering + false + boolean + + + maxiops + New maximum number of IOPS for the custom disk offering + false + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + long + + + shrinkok + Verify OK to Shrink + false + boolean + + + size + New volume size in GB for the custom disk offering + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteLdapConfiguration + Remove an Ldap Configuration + false + 4.2.0 + + + hostname + Hostname + true + string + + + domainid + linked domain + false + uuid + + + port + port + false + integer + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port the ldap server is running on + int + + + false + + + createProjectRole + Creates a Project role + false + 4.15.0 + + + name + creates a project role with this unique name + true + string + + + projectid + ID of project where role is being created + true + uuid + + + description + The description of the Project role + false + string + + + + + projectid + the id of the project + string + + + false + + + createIpv6FirewallRule + Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC) + true + + + networkid + The network of the VM the Ipv6 firewall rule will be created for + true + uuid + + + protocol + the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + true + string + + + cidrlist + the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + destcidrlist + the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of Ipv6 firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + startport + the starting port of Ipv6 firewall rule + false + integer + + + traffictype + the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + triggerShutdown + Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced + false + 4.19.0 + + + managementserverid + the uuid of the management server + true + uuid + + + + + managementserverid + The id of the management server + long + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + updateNetwork + Updates a network + true + + + id + the ID of the network + true + uuid + + + changecidr + Force update even if CIDR type is different + false + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + false + boolean + + + displaytext + the new display text for the network + false + string + + + dns1 + the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone + false + 4.18.0 + string + + + forced + Setting this to true will cause a forced network update, + false + boolean + + + guestvmcidr + CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR + false + string + + + hideipaddressusage + when true ip address usage for the network will not be exported by the listUsageRecords API + false + boolean + + + ip6dns1 + the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone + false + 4.18.0 + string + + + name + the new name for the network + false + string + + + networkdomain + network domain + false + string + + + networkofferingid + network offering ID + false + uuid + + + privatemtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network + false + 4.19 + string + + + updateinsequence + if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider + false + boolean + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listBackups + Lists VM backups + false + 4.14.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + id of the backup + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + virtualmachineid + id of the VM + false + uuid + + + zoneid + list backups by zone id + false + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + date + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + listUsageTypes + List Usage Types + false + + + + description + description of usage type + string + + + usagetypeid + usage type + integer + + + false + + + listBackupProviders + Lists Backup and Recovery providers + false + 4.14.0 + + + name + List Backup and Recovery provider by name + false + string + + + + + description + the description of the CA service provider + string + + + name + the CA service provider name + string + + + false + + + deleteVPC + Deletes a VPC + true + + + id + the ID of the VPC + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateVirtualMachine + Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default + false + 4.16.0 + boolean + + + hostid + Destination Host ID to migrate VM to. + false + uuid + + + storageid + Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteKubernetesSupportedVersion + Deletes a Kubernetes cluster + true + + + id + the ID of the Kubernetes supported version + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBaremetalRct + list baremetal rack configuration + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + id of rct + string + + + url + url + string + + + false + + + listCAProviders + Lists available certificate authority providers in CloudStack + false + 4.11.0 + + + name + List CA service provider by name + false + string + + + + + description + the description of the CA service provider + string + + + name + the CA service provider name + string + + + false + + + deleteVpnCustomerGateway + Delete site to site vpn customer gateway + true + + + id + id of customer gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listPortForwardingRules + Lists all port forwarding rules for an IP address. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the port forwarding services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list port forwarding rules for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + enableOutOfBandManagementForCluster + Enables out-of-band management for a cluster + true + 4.9.0 + + + clusterid + the ID of the cluster + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + acquirePodIpAddress + Allocates IP addresses in respective Pod of a Zone + false + + + zoneid + the ID of the zone + true + string + + + podid + Pod ID + false + string + + + + + id + the ID of the pod the IP address + long + + + cidr + CIDR of the Pod + string + + + gateway + Gateway for Pod + string + + + hostmac + MAC address of the pod the IP + long + + + ipaddress + Allocated IP address + string + + + nicid + the ID of the nic + long + + + podid + the ID of the pod the IP address belongs to + long + + + false + + + updateTemplatePermissions + Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them. + false + + + id + the template ID + true + uuid + + + accounts + a comma delimited list of accounts within caller's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + isextractable + true if the template/iso is extractable, false other wise. Can be set only by root admin + false + boolean + + + isfeatured + true for featured template/iso, false otherwise + false + boolean + + + ispublic + true for public template/iso, false for private templates/isos + false + boolean + + + op + permission operator (add, remove, reset) + false + string + + + projectids + a comma delimited list of projects. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + resetPasswordForVirtualMachine + Resets the password for virtual machine. The virtual machine must be in a "Stopped" state and the template must already support this feature for this command to take effect. [async] + true + + + id + The ID of the virtual machine + true + uuid + + + password + The new password of the virtual machine. If null, a random password will be generated for the VM. + false + 4.19.0 + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listBrocadeVcsDevices + Lists Brocade VCS Switches + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + vcsdeviceid + Brocade VCS switch ID + false + uuid + + + + + brocadedevicename + device name + string + + + hostname + the principal switch Ip address + string + + + physicalnetworkid + the physical Network to which this Brocade VCS belongs to + string + + + provider + name of the provider + string + + + vcsdeviceid + device id of the Brocade Vcs + string + + + false + + + linkDomainToLdap + link an existing cloudstack domain to group or OU in ldap + false + 4.6.0 + + + accounttype + Type of the account to auto import. Specify 0 for user and 2 for domain admin + true + integer + + + domainid + The id of the domain which has to be linked to LDAP. + true + uuid + + + type + type of the ldap name. GROUP or OU + true + string + + + admin + domain admin username in LDAP + false + string + + + ldapdomain + name of the group or OU in LDAP + false + string + + + name + name of the group or OU in LDAP + false + string + + + + + accountid + Domain Admin accountId that is created + string + + + accounttype + Type of the account to auto import + int + + + domainid + id of the Domain which is linked to LDAP + string + + + ldapdomain + name of the group or OU in LDAP which is linked to the domain + string + + + name + name of the group or OU in LDAP which is linked to the domain + string + + + type + type of the name in LDAP which is linked to the domain + string + + + false + + + setupUserTwoFactorAuthentication + Setup the 2FA for the user. + false + 4.18.0 + + + enable + Enabled by default, provide false to disable 2FA + false + boolean + + + provider + two factor authentication code + false + string + + + userid + optional: the id of the user for which 2FA has to be disabled + false + uuid + + + + + id + the user ID + string + + + accountid + the account ID of the user + string + + + secretcode + secret code that needs to be registered with authenticator + string + + + username + the user name + string + + + false + + + listVmwareDcHosts + Lists the VMs in a Vmware Datacenter + false + + + datacentername + Name of Vmware datacenter. + false + string + + + existingvcenterid + UUID of a linked existing vCenter + false + uuid + + + password + The password for specified username. + false + string + + + username + The Username required to connect to resource. + false + string + + + vcenter + The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + token + The Vmware API token to use for retrieving further responses with + string + + + false + + + listVpnCustomerGateways + Lists site to site vpn customer gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + id of the customer gateway + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + deleteKubernetesCluster + Deletes a Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + cleanup + Destroy attached instances of the ExternalManaged Cluster. Default: false + false + 4.19.0 + boolean + + + expunge + Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false + false + 4.19.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAndSwitchSamlAccount + Lists and switches to other SAML accounts owned by the SAML user + false + + + domainid + Domain uuid + false + uuid + + + userid + User uuid + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createGlobalLoadBalancerRule + Creates a global load balancer rule + true + + + gslbdomainname + domain name for the GSLB service. + true + string + + + gslbservicetype + GSLB service type (tcp, udp, http) + true + string + + + name + name of the load balancer rule + true + string + + + regionid + region where the global load balancer is going to be created. + true + integer + + + account + the account associated with the global load balancer. Must be used with the domainId parameter. + false + string + + + description + the description of the load balancer rule + false + string + + + domainid + the domain ID associated with the load balancer + false + uuid + + + gslblbmethod + load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin' + false + string + + + gslbstickysessionmethodname + session sticky method (sourceip) if not specified defaults to sourceip + false + string + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + deleteNetscalerLoadBalancer + delete a netscaler load balancer device + true + + + lbdeviceid + netscaler load balancer device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTags + List resource tag(s) + false + 4.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + customer + list by customer name + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + key + list by key + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + list by resource id + false + string + + + resourcetype + list by resource type + false + string + + + value + list by value + false + string + + + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + false + + + listAffectedVmsForStorageScopeChange + List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster. + false + 4.19.1 + + + clusterid + the Id of the cluster the scope of the storage pool is being changed to + true + uuid + + + storageid + the Id of the storage pool on which change scope operation is being done + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the VM + string + + + clusterid + the cluster ID for the VM + string + + + clustername + the cluster name for the VM + string + + + hostid + the host ID for the VM + string + + + hostname + the hostname for the VM + string + + + name + the name of the VM + string + + + type + the type of VM + string + + + false + + + createVirtualRouterElement + Create a virtual router element. + true + + + nspid + the network service provider ID of the virtual router element + true + uuid + + + providertype + The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + createVPC + Creates a VPC + true + + + cidr + the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR + true + string + + + name + the name of the VPC + true + string + + + vpcofferingid + the ID of the VPC offering + true + uuid + + + zoneid + the ID of the availability zone + true + uuid + + + account + the account associated with the VPC. Must be used with the domainId parameter. + false + string + + + displaytext + The display text of the VPC, defaults to its 'name'. + false + string + + + dns1 + the first IPv4 DNS for the VPC + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the VPC + false + 4.18.0 + string + + + domainid + the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain. + false + uuid + + + fordisplay + an optional field, whether to the display the vpc to the end user or not + false + 4.4 + boolean + + + ip6dns1 + the first IPv6 DNS for the VPC + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + false + 4.18.0 + string + + + networkdomain + VPC network domain. All networks inside the VPC will belong to this domain + false + string + + + projectid + create VPC for the project + false + uuid + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. +If an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented, + false + 4.19 + string + + + start + If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default. + false + 4.3 + boolean + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + removeResourceDetail + Removes detail for the Resource. + true + + + resourceid + Delete details for resource id + true + string + + + resourcetype + Delete detail by resource type + true + string + + + key + Delete details matching key/value pairs + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listOsTypes + Lists all supported OS types for this cloud. + false + + + description + list os by description + false + 3.0.1 + string + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.18.1 + boolean + + + id + list by Os type Id + false + uuid + + + keyword + List by keyword + false + string + + + oscategoryid + list by Os Category id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + fordisplay + is the guest OS visible for the users + boolean + + + isuserdefined + is the guest OS user defined + boolean + + + name + the name of the OS type + string + + + oscategoryid + the ID of the OS category + string + + + oscategoryname + the name of the OS category + string + + + false + + + removeGuestOs + Removes a Guest OS from listing. + true + 4.4.0 + + + id + ID of the guest OS + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + detachIso + Detaches any ISO file (if any) currently attached to a virtual machine. + true + + + virtualmachineid + The ID of the virtual machine + true + uuid + + + forced + If true, ejects the ISO before detaching on VMware. Default: false + false + 4.15.1 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deletePaloAltoFirewall + delete a Palo Alto firewall device + true + + + fwdeviceid + Palo Alto firewall device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deletePod + Deletes a Pod. + false + + + id + the ID of the Pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricProviders + Lists Tungsten-Fabric providers + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + false + uuid + + + + + name + Tungsten-Fabric provider name + string + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + tungstengateway + Tungsten-Fabric provider gateway + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + string + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + string + + + tungstenproviderport + Tungsten-Fabric provider port + string + + + tungstenprovideruuid + Tungsten-Fabric provider uuid + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listDeploymentPlanners + Lists all DeploymentPlanners available. + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + Deployment Planner name + string + + + false + + + prepareHostForMaintenance + Prepares a host for maintenance. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteCluster + Deletes a cluster. + false + + + id + the cluster ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + removeRegion + Removes specified region + false + + + id + ID of the region to delete + true + integer + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getVolumeiScsiName + Get Volume's iSCSI Name + false + + + volumeid + CloudStack Volume UUID + true + string + + + + + volumeiScsiName + Volume iSCSI Name + string + + + false + + + updateAutoScaleVmGroup + Updates an existing autoscale vm group. + true + + + id + the ID of the autoscale group + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the group to the end user or not + false + 4.4 + boolean + + + interval + the frequency in which the performance counters to be collected + false + integer + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + false + integer + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + false + integer + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + scaledownpolicyids + list of scaledown autoscale policies + false + list + list + + + scaleuppolicyids + list of scaleup autoscale policies + false + list + list + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + deleteSnapshot + Deletes a snapshot of a disk volume. + true + + + id + The ID of the snapshot + true + uuid + + + zoneid + The ID of the zone for the snapshot + false + 4.19.0 + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVirtualMachines + List the virtual machines owned by the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + clusterid + the cluster ID + false + 4.16.0 + uuid + + + details + comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hostid + the host ID + false + uuid + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. + false + 4.19.0 + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + storageid + the storage ID where vm's volumes belong to + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listDiskOfferings + Lists all available disk offerings. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + encrypt + listed offerings support disk encryption + false + 4.18 + boolean + + + id + ID of the disk offering + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the disk offering + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings. + false + 4.19 + string + + + storageid + The ID of the storage pool, tags of the storage pool are used to filter the offerings + false + 4.17 + uuid + + + storagetype + the storage type of the service offering. Values are local and shared. + false + 4.19 + string + + + volumeid + The ID of the volume, tags of the volume are used to filter the offerings + false + 4.17 + uuid + + + zoneid + id of zone disk offering is associated with + false + 4.13 + uuid + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + state + state of the disk offering + string + + + storagetype + the storage type for this disk offering + string + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + deleteCiscoAsa1000vResource + Deletes a Cisco ASA 1000v appliance + false + + + resourceid + Cisco ASA 1000v resource ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + upgradeKubernetesCluster + Upgrades a running CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + kubernetesversionid + the ID of the Kubernetes version for upgrade + true + uuid + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + createCondition + Creates a condition for VM auto scaling + true + + + counterid + ID of the Counter. + true + uuid + + + relationaloperator + Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE. + true + string + + + threshold + Value for which the Counter will be evaluated with the Operator selected. + true + long + + + account + the account of the condition. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID of the account. + false + uuid + + + projectid + an optional project for condition + false + uuid + + + + + id + the id of the Condition + string + + + account + the owner of the Condition. + string + + + counter + Details of the Counter. + counterresponse + + + counterid + the Id of the Counter. + string + + + countername + the Name of the Counter. + string + + + domain + the domain name of the owner. + string + + + domainid + the domain id of the Condition owner + string + + + domainpath + path of the domain to which the Condition owner belongs + 4.19.2.0 + string + + + project + the project name of the Condition + string + + + projectid + the project id of the Condition. + string + + + relationaloperator + Relational Operator to be used with threshold. + string + + + threshold + Threshold Value for the counter. + long + + + zoneid + zone id of counter + string + + + false + + + listProjects + Lists projects and provides detailed information for listed projects + false + 3.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + details + comma separated list of project details requested, value can be a list of [ all, resource, min] + false + list + list + + + displaytext + list projects by display text + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list projects by project ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list projects by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for projects + false + boolean + + + state + list projects by state + false + string + + + tags + List projects by tags (key/value pairs) + false + map + map + + + username + List projects by username + false + string + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createAccount + Creates an account + false + + + email + email + true + string + + + firstname + firstname + true + string + + + lastname + lastname + true + string + + + password + Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Unique username. + true + string + + + account + Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accountid + Account UUID, required for adding account from external provisioning system + false + string + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + Creates the user under the specified domain. + false + uuid + + + networkdomain + Network domain for the account's networks + false + string + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + revertToVMSnapshot + Revert VM from a vmsnapshot. + true + 4.2.0 + + + vmsnapshotid + The ID of the vm snapshot + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTungstenFabricServiceGroup + create Tungsten-Fabric service group + true + + + endport + Tungsten-Fabric service group end port + true + integer + + + name + Tungsten-Fabric service group name + true + string + + + protocol + Tungsten-Fabric service group protocol + true + string + + + startport + Tungsten-Fabric service group start port + true + integer + + + zoneid + the ID of zone + true + uuid + + + + + endport + Tungsten-Fabric service group end port + int + + + name + Tungsten-Fabric service group name + string + + + protocol + Tungsten-Fabric service group protocol + string + + + startport + Tungsten-Fabric service group start port + int + + + uuid + Tungsten-Fabric service group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + removeGuestOsMapping + Removes a Guest OS Mapping. + true + 4.4.0 + + + id + ID of the guest OS mapping + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + registerIso + Registers an existing ISO into the CloudStack Cloud. + false + + + name + the name of the ISO + true + string + + + url + the URL to where the ISO is currently being hosted + true + string + + + zoneid + the ID of the zone you wish to register the ISO to. + true + uuid + + + account + an optional account name. Must be used with domainId. + false + string + + + bootable + true if this ISO is bootable. If not passed explicitly its assumed to be true + false + boolean + + + checksum + the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + directdownload + true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + displaytext + the display text of the ISO, defaults to the 'name' + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + imagestoreuuid + Image store UUID + false + string + + + isdynamicallyscalable + true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory + false + boolean + + + isextractable + true if the ISO or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if you want this ISO to be featured + false + boolean + + + ispublic + true if you want to register the ISO to be publicly available to all users, false otherwise. + false + boolean + + + ostypeid + the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed + false + uuid + + + passwordenabled + true if password reset feature is supported; default is false + false + boolean + + + projectid + Register ISO for the project + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listCiscoAsa1000vResources + Lists Cisco ASA 1000v appliances + false + + + hostname + Hostname or ip address of the Cisco ASA 1000v appliance. + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + resourceid + Cisco ASA 1000v resource ID + false + uuid + + + + false + + + deletePortableIpRange + deletes a range of portable public IP's associated with a region + true + + + id + Id of the portable ip range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + upgradeRouterTemplate + Upgrades router to use newer template + false + + + account + upgrades all routers owned by the specified account + false + string + + + clusterid + upgrades all routers within the specified cluster + false + uuid + + + domainid + upgrades all routers owned by the specified domain + false + uuid + + + id + upgrades router with the specified Id + false + uuid + + + podid + upgrades all routers within the specified pod + false + uuid + + + zoneid + upgrades all routers within the specified zone + false + uuid + + + + + jobid + the UUID of the latest async job acting on this object + string + + + jobstatus + the current status of the latest async job acting on this object + integer + + + false + + + listVlanIpRanges + Lists all VLAN IP ranges. + false + + + account + the account with which the VLAN IP range is associated. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain. + false + uuid + + + forvirtualnetwork + true if VLAN is of Virtual type, false if Direct + false + boolean + + + id + the ID of the VLAN IP range + false + uuid + + + keyword + List by keyword + false + string + + + networkid + network id of the VLAN IP range + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + physical network id of the VLAN IP range + false + uuid + + + podid + the Pod ID of the VLAN IP range + false + uuid + + + projectid + project who will own the VLAN + false + uuid + + + vlan + the ID or VID of the VLAN. Default is an "untagged" VLAN. + false + string + + + zoneid + the Zone ID of the VLAN IP range + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + extractVolume + Extracts volume + true + + + id + the ID of the volume + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + zoneid + the ID of the zone where the volume is located + true + uuid + + + url + the url to which the volume would be extracted + false + string + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + cancelHostMaintenance + Cancels host maintenance. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateZone + Updates a Zone. + false + + + id + the ID of the Zone + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + details + the details for the Zone + false + map + map + + + dhcpprovider + the dhcp Provider for the Zone + false + string + + + dns1 + the first DNS for the Zone + false + string + + + dns2 + the second DNS for the Zone + false + string + + + dnssearchorder + the dns search order list + false + list + list + + + domain + Network domain name for the networks in the zone; empty string will update domain with NULL value + false + string + + + guestcidraddress + the guest CIDR address for the Zone + false + string + + + internaldns1 + the first internal DNS for the Zone + false + string + + + internaldns2 + the second internal DNS for the Zone + false + string + + + ip6dns1 + the first DNS for IPv6 network in the Zone + false + string + + + ip6dns2 + the second DNS for IPv6 network in the Zone + false + string + + + ispublic + updates a private zone to public if set, but not vice-versa + false + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + false + boolean + + + name + the name of the Zone + false + string + + + sortkey + sort key of the zone, integer + false + integer + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listProjectAccounts + Lists project's accounts + false + 3.0.0 + + + projectid + ID of the project + true + uuid + + + account + list accounts of the project by account name + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectroleid + list accounts of the project by project role id + false + uuid + + + role + list accounts of the project by role + false + string + + + userid + list invitation by user ID + false + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateAutoScalePolicy + Updates an existing autoscale policy. + true + + + id + the ID of the autoscale policy + true + uuid + + + conditionids + the list of IDs of the conditions that are being evaluated on every interval + false + list + list + + + duration + the duration in which the conditions have to be true before action is taken + false + integer + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + quiettime + the cool down period in which the policy should not be evaluated after the action has been taken + false + integer + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + domainpath + path of the domain to which the autoscale policy belongs + 4.19.2.0 + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + createDiskOffering + Creates a disk offering. + false + + + name + name of the disk offering + true + string + + + bytesreadrate + bytes read rate of the disk offering + false + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + long + + + byteswriterate + bytes write rate of the disk offering + false + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + long + + + cachemode + the cache mode to use for this disk offering. none, writeback or writethrough + false + 4.14 + string + + + customized + whether disk offering size is custom or not + false + boolean + + + customizediops + whether disk offering iops is custom or not + false + boolean + + + details + details to specify disk offering parameters + false + map + 4.16 + map + + + disksize + size of the disk offering in GB (1GB = 1,073,741,824 bytes) + false + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + false + 4.17 + boolean + + + displayoffering + an optional field, whether to display the offering to the end user or not. + false + boolean + + + displaytext + An alternate display text of the disk offering, defaults to 'name'. + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + encrypt + Volumes using this offering should be encrypted + false + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + false + integer + + + iopsreadrate + io requests read rate of the disk offering + false + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + long + + + iopswriterate + io requests write rate of the disk offering + false + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + long + + + maxiops + max iops of the disk offering + false + long + + + miniops + min iops of the disk offering + false + long + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + false + string + + + storagepolicy + Name of the storage policy defined at vCenter, this is applicable only for VMware + false + 4.15 + uuid + + + storagetype + the storage type of the disk offering. Values are local and shared. + false + string + + + tags + tags for the disk offering + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + state + state of the disk offering + string + + + storagetype + the storage type for this disk offering + string + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + listLBHealthCheckPolicies + Lists load balancer health check policies. + false + 4.2.0 + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the health check policy + false + 4.4 + uuid + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the load balancer rule + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + migrateVirtualMachineWithVolume + Attempts Migration of a VM with its volumes to a different host + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host for a running instance, if hostId is not specified. false by default + false + 4.19.0 + boolean + + + hostid + Destination Host ID to migrate VM to. + false + uuid + + + migrateto + Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=<uuid>&migrateto[volume-index].pool=<uuid>Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume=<uuid> indicates the UUID of the volume that you want to migrate, and pool=<uuid> indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc> + false + map + map + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateUser + Updates a user account + false + + + id + User uuid + true + uuid + + + currentpassword + Current password that was being used by the user. You must inform the current password when updating the password. + false + string + + + email + email + false + string + + + firstname + first name + false + string + + + lastname + last name + false + string + + + mandate2fa + Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA + false + 4.18.0.0 + boolean + + + password + Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port + false + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userapikey + The API key for the user. Must be specified with userSecretKey + false + string + + + username + Unique username + false + string + + + usersecretkey + The secret key for the user. Must be specified with userApiKey + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + removeCertFromLoadBalancer + Removes a certificate from a load balancer rule + true + + + lbruleid + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + attachVolume + Attaches a disk volume to a virtual machine. + true + + + id + the ID of the disk volume + true + uuid + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + deviceid + The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.<br>When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:<ul><li>0 maps to /dev/xvda;</li><li>1 maps to /dev/xvdb;</li><li>2 maps /dev/xvdc and so on.</li></ul>Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure. + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addHost + Adds a new host. + false + + + hypervisor + hypervisor type of the host + true + string + + + podid + the Pod ID for the host + true + uuid + + + url + the host URL + true + string + + + zoneid + the Zone ID for the host + true + uuid + + + allocationstate + Allocation state of this Host for allocation of new resources + false + string + + + clusterid + the cluster ID for the host + false + uuid + + + clustername + the cluster name for the host + false + string + + + hosttags + list of tags to be added to the host + false + list + list + + + password + the password for the host; required to be passed for hypervisors other than VMWare + false + string + + + username + the username for the host; required to be passed for hypervisors other than VMWare + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listLoadBalancers + Lists internal load balancers + false + 4.2.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the load balancer + false + string + + + networkid + the network ID of the load balancer + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + scheme + the scheme of the load balancer. Supported value is internal in the current release + false + string + + + sourceipaddress + the source IP address of the load balancer + false + string + + + sourceipaddressnetworkid + the network ID of the source IP address + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + domainpath + path of the domain to which the Load Balancer belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateProject + Updates a project + true + 3.0.0 + + + id + id of the project to be modified + true + uuid + + + account + new Admin account for the project + false + string + + + displaytext + display text of the project + false + string + + + name + name of the project + false + 4.19.0 + string + + + roletype + Account level role to be assigned to the user/account : Admin/Regular + false + string + + + swapowner + when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true + false + boolean + + + userid + ID of the user to be promoted/demoted + false + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteLBStickinessPolicy + Deletes a load balancer stickiness policy. + true + 3.0.0 + + + id + the ID of the LB stickiness policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + registerUserKeys + This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user + false + + + id + User id + true + uuid + + + + + apikey + the api key of the registered user + string + + + secretkey + the secret key of the registered user + string + + + false + + + listVpnConnections + Lists site to site vpn connection gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + id of the vpn connection + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + id of vpc + false + uuid + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + removeTungstenFabricPolicy + remove Tungsten-Fabric policy + true + + + networkuuid + the uuid of Tungsten-Fabric network + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateCloudToUseObjectStore + Migrate current NFS secondary storages to use object store. + false + 4.3.0 + + + provider + the image store provider name + true + string + + + details + the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + name + the name for the image store + false + string + + + url + the URL for the image store + false + string + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + addTungstenFabricNetworkGatewayToLogicalRouter + add Tungsten-Fabric network gateway to logical router + true + + + logicalrouteruuid + Tungsten-Fabric logical router uuid + true + string + + + networkuuid + Tungsten-Fabric network uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listTungstenFabricNic + list Tungsten-Fabric nic + false + + + keyword + List by keyword + false + string + + + nicuuid + the uuid of Tungsten-Fabric nic + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric nic name + string + + + uuid + Tungsten-Fabric nic uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listVmwareDcs + Retrieves Vmware DC(s) associated with a zone. + false + + + zoneid + Id of the CloudStack zone. + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + applyTungstenFabricPolicy + apply Tungsten-Fabric policy + true + + + majorsequence + the major sequence of Tungsten-Fabric policy + true + integer + + + minorsequence + the minor sequence of Tungsten-Fabric policy + true + integer + + + networkuuid + the uuid of network + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listZones + Lists zones + false + + + available + true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false. + false + boolean + + + domainid + the ID of the domain associated with the zone + false + uuid + + + id + the ID of the zone + false + uuid + + + ids + the IDs of the zones, mutually exclusive with id + false + list + 4.19.0 + list + + + keyword + List by keyword + false + string + + + name + the name of the zone + false + string + + + networktype + the network type of the zone that the virtual machine belongs to + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the zones + false + boolean + + + showicon + flag to display the resource image for the zones + false + boolean + + + tags + List zones by resource tags (key/value pairs) + false + map + 4.3 + map + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + removeQuarantinedIp + Removes a public IP address from quarantine. Only IPs in active quarantine can be removed. + false + 4.19 + + + removalreason + The reason for removing the public IP address from quarantine prematurely. + true + string + + + id + The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine. + false + uuid + + + ipaddress + The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine. + false + string + + + + + id + ID of the quarantine process. + string + + + created + When the quarantine was created. + date + + + enddate + End date for the quarantine. + date + + + ipaddress + The public IP address in quarantine. + string + + + previousownerid + Account ID of the previous public IP address owner. + string + + + previousownername + Account name of the previous public IP address owner. + string + + + removalreason + The reason for removing the IP from quarantine prematurely. + string + + + removed + When the quarantine was removed. + date + + + removeraccountid + ID of the account that removed the IP from quarantine. + string + + + false + + + deleteBackupSchedule + Deletes the backup schedule of a VM + false + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBackupProviderOfferings + Lists external backup offerings of the provider + false + 4.14.0 + + + zoneid + The zone ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + releasePublicIpRange + Releases a Public IP range back to the system pool + false + + + id + the id of the Public IP range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetscalerLoadBalancerNetworks + lists network that are using a netscaler load balancer device + false + + + lbdeviceid + netscaler load balancer device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createTungstenFabricPublicNetwork + create Tungsten-Fabric public network + false + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listHostHAResources + Lists host HA resources + false + 4.11 + + + hostid + List by host ID + false + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + listNetworkIsolationMethods + Lists supported methods of network isolation + false + 4.2.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + Network isolation method name + string + + + false + + + listTungstenFabricFirewallPolicy + list Tungsten-Fabric firewall policy + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + firewallrule + list Tungsten-Fabric firewall rule + list + + + name + Tungsten-Fabric firewall policy name + string + + + uuid + Tungsten-Fabric firewall policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + importBackupOffering + Imports a backup offering using a backup provider + true + 4.14.0 + + + allowuserdrivenbackups + Whether users are allowed to create adhoc backups and backup schedules + true + boolean + + + description + the description of the backup offering + true + string + + + externalid + The backup offering ID (from backup provider side) + true + string + + + name + the name of the backup offering + true + string + + + zoneid + The zone ID + true + uuid + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + deleteDomain + Deletes a specified domain + true + + + id + ID of domain to delete + true + uuid + + + cleanup + true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateVolume + Migrate volume + true + 3.0.0 + + + storageid + destination storage pool ID to migrate the volume to + true + uuid + + + volumeid + the ID of the volume + true + uuid + + + livemigrate + if the volume should be live migrated when it is attached to a running vm + false + boolean + + + newdiskofferingid + The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to. + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTungstenFabricApplicationPolicySet + create Tungsten-Fabric application policy set + true + + + name + Tungsten-Fabric application policy set name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + firewallpolicy + list Tungsten-Fabric firewall policy + list + + + name + Tungsten-Fabric policy name + string + + + tag + list Tungsten-Fabric tag + list + + + uuid + Tungsten-Fabric application policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listEvents + A command to list events. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + archived + true to list archived events otherwise false + false + 4.19.0 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + duration + the duration of the event + false + integer + + + enddate + the end date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss") + false + date + + + entrytime + the time the event was entered + false + integer + + + id + the ID of the event + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + level + the event level (INFO, WARN, ERROR) + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + the ID of the resource associated with the event + false + 4.17.0 + string + + + resourcetype + the type of the resource associated with the event + false + 4.17.0 + string + + + startdate + the start date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss") + false + date + + + startid + the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event + false + uuid + + + type + the event type (see event types) + false + string + + + + + id + the ID of the event + string + + + account + the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group) + string + + + archived + whether the event has been archived or not + boolean + + + created + the date the event was created + date + + + description + a brief description of the event + string + + + domain + the name of the account's domain + string + + + domainid + the id of the account's domain + string + + + domainpath + path of the Domain the account's domain belongs to + 4.19.2.0 + string + + + level + the event level (INFO, WARN, ERROR) + string + + + parentid + whether the event is parented + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + resourceid + the id of the resource + 4.17.0 + string + + + resourcename + the name of the resource + 4.17.0 + string + + + resourcetype + the type of the resource + 4.17.0 + string + + + state + the state of the event + state + + + type + the type of the event (see event types) + string + + + username + the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine) + string + + + false + + + listHostHAProviders + Lists HA providers + false + 4.11 + + + hypervisor + Hypervisor type of the resource + true + string + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + createTags + Creates resource tag(s) + true + 4.0.0 + + + resourceids + list of resources to create the tags for + true + list + list + + + resourcetype + type of the resource + true + string + + + tags + Map of tags (key/value pairs) + true + map + map + + + customer + identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createInternalLoadBalancerElement + Create an Internal Load Balancer element. + true + 4.2.0 + + + nspid + the network service provider ID of the internal load balancer element + true + uuid + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + resetApiLimit + Reset api count + false + + + account + the ID of the account whose limit to be reset + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVlanIpRange + Deletes a VLAN IP range. + false + + + id + the id of the VLAN IP range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + generateAlert + Generates an alert + true + 4.3 + + + description + Alert description + true + string + + + name + Name of the alert + true + string + + + type + Type of the alert + true + short + + + podid + Pod id for which alert is generated + false + uuid + + + zoneid + Zone id for which alert is generated + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + ldapConfig + (Deprecated, use addLdapConfiguration) Configure the LDAP context for this site. + false + 3.0.0 + + + binddn + Specify the distinguished name of a user with the search permission on the directory. + false + string + + + bindpass + Enter the password. + false + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + false + string + + + listall + If true return current LDAP configuration + false + boolean + + + port + Specify the LDAP port if required, default is 389. + false + integer + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain. + false + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com. + false + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL. + false + boolean + + + truststore + Enter the path to trust certificates store. + false + string + + + truststorepass + Enter the password for trust store. + false + string + + + + + binddn + Specify the distinguished name of a user with the search permission on the directory + string + + + bindpass + DN password + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + string + + + port + Specify the LDAP port if required, default is 389 + string + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL + string + + + true + + + listVsphereStoragePolicies + List vSphere storage policies + false + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the Storage Policy + string + + + description + the description of the Storage Policy + string + + + name + the name of the Storage Policy + string + + + policyid + the identifier of the Storage Policy in vSphere DataCenter + string + + + zoneid + the ID of the Zone + string + + + false + + + deletePortForwardingRule + Deletes a port forwarding rule + true + + + id + the ID of the port forwarding rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateVPC + moves a vpc to another physical network + true + 4.11.0 + + + vpcid + the ID of the vpc + true + uuid + + + vpcofferingid + vpc offering ID + true + uuid + + + resume + true if previous network migration cmd failed + false + boolean + + + tiernetworkofferings + network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2 + false + map + map + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteGlobalLoadBalancerRule + Deletes a global load balancer rule. + true + + + id + the ID of the global load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateAnnotationVisibility + update an annotation visibility. + false + 4.16 + + + id + the id of the annotation + true + string + + + adminsonly + the annotation is visible for admins only + true + boolean + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + configureHAForHost + Configures HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + provider + HA provider + true + string + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + updateConfiguration + Updates a configuration. + false + + + name + the name of the configuration + true + string + + + accountid + the ID of the Account to update the parameter value for corresponding account + false + uuid + + + clusterid + the ID of the Cluster to update the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to update the parameter value for corresponding domain + false + uuid + + + imagestoreuuid + the ID of the Image Store to update the parameter value for corresponding image store + false + uuid + + + storageid + the ID of the Storage pool to update the parameter value for corresponding storage pool + false + uuid + + + value + the value of the configuration + false + string + + + zoneid + the ID of the Zone to update the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + listVolumesUsageHistory + Lists volume stats + false + 4.18.0 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the volume. + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the volume + string + + + name + the name of the volume + string + + + stats + the list of VM stats + list + + + false + + + dedicatePublicIpRange + Dedicates a Public IP range to an account + false + + + id + the id of the VLAN IP range + true + uuid + + + domainid + domain ID of the account owning a VLAN + true + uuid + + + account + account who will own the VLAN + false + string + + + projectid + project who will own the VLAN + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + createProjectRolePermission + Adds API permissions to a project role + false + 4.15.0 + + + permission + The rule permission, allow or deny. Default: deny. + true + string + + + projectid + ID of project where project role permission is to be created + true + uuid + + + projectroleid + ID of the project role + true + uuid + + + rule + The API name or wildcard rule such as list* + true + string + + + description + The description of the role permission + false + string + + + + + id + the ID of the project role permission + string + + + projectid + the ID of the project + string + + + projectroleid + the ID of the project role to which the role permission belongs + string + + + projectrolename + the name of the project role to which the role permission belongs + string + + + false + + + deleteBucket + Deletes an empty Bucket. + false + 4.19.0 + + + id + The ID of the Bucket + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createConsoleEndpoint + Create a console endpoint to connect to a VM console + false + 4.18.0 + + + virtualmachineid + ID of the VM + true + uuid + + + token + (optional) extra security token, valid when the extra validation is enabled + false + string + + + + + details + details in case of an error + string + + + success + true if the console endpoint is generated properly + boolean + + + url + the console url + string + + + websocket + the console websocket options + consoleendpointwebsocketresponse + + + false + + + updateProjectRolePermission + Updates a project role permission and/or order + false + 4.15.0 + + + projectid + ID of project where project role permission is to be updated + true + uuid + + + projectroleid + ID of the project role + true + uuid + + + permission + Rule permission, can be: allow or deny + false + string + + + projectrolepermissionid + Project Role permission rule id + false + uuid + + + ruleorder + The parent role permission uuid, use 0 to move this rule at the top of the list + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addUserToProject + Adds user to a project + true + 4.14 + + + projectid + ID of the project to add the user to + true + uuid + + + username + Name of the user to be added to the project + true + string + + + email + email ID of user to which invitation to the project is going to be sent + false + string + + + projectroleid + ID of the project role + false + uuid + + + roletype + Project role type to be assigned to the user - Admin/Regular + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableHAForCluster + Disables HA cluster-wide + true + 4.11 + + + clusterid + ID of the cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteTungstenFabricFirewallPolicy + delete Tungsten-Fabric firewall policy + true + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + recoverVirtualMachine + Recovers a virtual machine. + false + + + id + The ID of the virtual machine + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + resetNetworkPermissions + Resets network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateTungstenFabricLBHealthMonitor + update Tungsten-Fabric loadbalancer health monitor + true + + + interval + loadbalancer health monitor interval + true + integer + + + lbruleid + the ID of lb rule + true + uuid + + + retry + loadbalancer health monitor retry + true + integer + + + timeout + loadbalancer health monitor timeout + true + integer + + + type + loadbalancer health monitor type + true + string + + + expectedcode + loadbalancer health monitor expected code + false + string + + + httpmethodtype + loadbalancer health monitor http method + false + string + + + urlpath + loadbalancer health monitor url path + false + string + + + + + id + the health monitor ID + long + + + expectedcode + the health monitor expected code + string + + + httpmethod + the health monitor http method + string + + + interval + the health monitor interval + int + + + lbruleid + the LB rule ID + string + + + retry + the health monitor retry + int + + + timeout + the health monitor timeout + int + + + type + the health monitor type + string + + + urlpath + the health monitor url path + string + + + uuid + the health monitor UUID + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + releaseDedicatedHost + Release the dedication for host + true + + + hostid + the ID of the host + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateProjectInvitation + Accepts or declines project invitation + true + 3.0.0 + + + projectid + id of the project to join + true + uuid + + + accept + if true, accept the invitation, decline if false. True by default + false + boolean + + + account + account that is joining the project + false + string + + + token + list invitations for specified account; this parameter has to be specified with domainId + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + revertSnapshot + This is supposed to revert a volume snapshot. This command is only supported with KVM so far + true + + + id + The ID of the snapshot + true + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateCondition + Updates a condition for VM auto scaling + true + 4.18.0 + + + id + the ID of the condition. + true + uuid + + + relationaloperator + Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE. + true + string + + + threshold + Value for which the Counter will be evaluated with the Operator selected. + true + long + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listRegions + Lists Regions + false + + + id + List Region by region ID. + false + integer + + + keyword + List by keyword + false + string + + + name + List Region by region name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + migrateSystemVm + Attempts Migration of a system virtual machine to the host specified. + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default + false + 4.16.0 + boolean + + + hostid + destination Host ID to migrate VM to + false + uuid + + + storageid + Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume + false + 4.16.0 + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + removeTungstenFabricTag + remove Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + networkuuid + the uuid of networks + false + list + list + + + nicuuid + the uuid of nics + false + list + list + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + vmuuid + the uuid of vms + false + list + list + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + configureInternalLoadBalancerElement + Configures an Internal Load Balancer element. + true + 4.2.0 + + + id + the ID of the internal lb provider + true + uuid + + + enabled + Enables/Disables the Internal Load Balancer element + true + boolean + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + listCounters + List the counters for VM auto scaling + false + + + id + ID of the Counter. + false + uuid + + + keyword + List by keyword + false + string + + + name + Name of the counter. + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + Network provider of the counter. + false + 4.18.0 + string + + + source + Source of the counter. + false + string + + + + + id + the id of the Counter + string + + + name + Name of the counter. + string + + + provider + Provider of the counter. + string + + + source + Source of the counter. + string + + + value + Value in case of snmp or other specific counters. + string + + + zoneid + zone id of counter + string + + + false + + + listVirtualRouterElements + Lists all available virtual router elements. + false + + + enabled + list network offerings by enabled state + false + boolean + + + id + list virtual router elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list virtual router elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + linkAccountToLdap + link a cloudstack account to a group or OU in ldap + false + 4.11.0 + + + account + name of the account, it will be created if it does not exist + true + string + + + domainid + The id of the domain that is to contain the linked account. + true + uuid + + + ldapdomain + name of the group or OU in LDAP + true + string + + + accounttype + Type of the account to auto import. Specify 0 for user and 2 for domain admin + false + integer + + + admin + domain admin username in LDAP + false + string + + + roleid + Creates the account under the specified role. + false + 4.19.1 + uuid + + + type + type of the ldap name. GROUP or OU, defaults to GROUP + false + string + + + + + accountid + Domain Admin accountId that is created + string + + + accounttype + Type of the account to auto import + int + + + domainid + id of the Domain which is linked to LDAP + string + + + ldapdomain + name of the group or OU in LDAP which is linked to the domain + string + + + name + name of the group or OU in LDAP which is linked to the domain + string + + + type + type of the name in LDAP which is linked to the domain + string + + + false + + + disableOutOfBandManagementForHost + Disables out-of-band management for a host + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + cancelHostAsDegraded + Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'. + true + 4.16.0.0 + + + id + host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createSecurityGroup + Creates a security group + false + + + name + name of the security group + true + string + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + description + the description of the security group + false + string + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + Create security group for project + false + uuid + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeVirtualMachineFromBackupOffering + Removes a VM from any existing backup offering + true + 4.14.0 + + + virtualmachineid + ID of the virtual machine + true + uuid + + + forced + Whether to force remove VM from the backup offering that may also delete VM backups. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkPermissions + List network visibility and all accounts that have permissions to view this network. + false + 4.17.0 + + + networkid + Lists network permission by network ID + true + uuid + + + + + account + the account the network is available for + string + + + accountid + the ID of account the network is available for + string + + + domain + the name of the domain to which the network belongs + string + + + domainid + the ID of the domain to which the network belongs + string + + + networkid + the network ID + string + + + project + the project the network is available for + string + + + projectid + the ID of project the network is available for + string + + + false + + + listVpnGateways + Lists site 2 site vpn gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + id of the vpn gateway + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + id of vpc + false + uuid + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + moveUser + Moves a user to another account in the same domain. + false + 4.11 + + + id + id of the user to be moved. + true + uuid + + + account + Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id. + false + string + + + accountid + Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name. + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + releaseHostReservation + Releases host reservation. + true + + + id + the host ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVpnConnection + Create site to site vpn connection + true + + + s2scustomergatewayid + id of the customer gateway + true + uuid + + + s2svpngatewayid + id of the vpn gateway + true + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + passive + connection is passive or not + false + boolean + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + listBrocadeVcsDeviceNetworks + lists network that are using a brocade vcs switch + false + + + vcsdeviceid + brocade vcs switch ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + dedicateHost + Dedicates a host. + true + + + domainid + the ID of the containing domain + true + uuid + + + hostid + the ID of the host to update + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the host + string + + + affinitygroupid + the Dedication Affinity Group ID of the host + string + + + domainid + the domain ID of the host + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + false + + + addGloboDnsHost + Adds the GloboDNS external host + true + 4.5.0 + + + password + Password for GloboDNS + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + GloboDNS url + true + string + + + username + Username for GloboDNS + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + logout + Logs out the user + false + + + + description + Response description + string + + + false + + + importRole + Imports a role based on provided map of rule permissions + false + 4.15.0 + + + name + Creates a role with this unique name + true + string + + + rules + Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing + true + map + map + + + description + The description of the role + false + string + + + forced + Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false. + false + boolean + + + ispublic + Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public). + false + boolean + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + quotaEmailTemplateUpdate + Updates existing email templates for quota alerts + false + 4.7.0 + + + templatebody + The quota email template body, max: 500k characters + true + string + + + templatesubject + The quota email template subject, max: 77 characters + true + string + + + templatetype + Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY + true + string + + + locale + The locale of the email text + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteTungstenFabricTagType + delete Tungsten-Fabric tag type + true + + + tagtypeuuid + the ID of Tungsten-Fabric tag type + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkServiceProviders + Lists network serviceproviders for a given physical network. + false + 3.0.0 + + + keyword + List by keyword + false + string + + + name + list providers by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + state + list providers by state + false + string + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + deleteNetscalerControlCenter + Delete Netscaler Control Center + false + + + id + Netscaler Control Center ID + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteObjectStoragePool + Deletes an Object Storage Pool + false + 4.19.0 + + + id + The Object Storage ID. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVolume + Deletes a detached disk volume. + false + + + id + The ID of the disk volume + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateSecondaryStorageSelector + Updates an existing secondary storage selector. + false + 4.19.0 + + + id + The unique identifier of the secondary storage selector. + true + uuid + + + heuristicrule + The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID. + true + string + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + enableUser + Enables a user account + false + + + id + Enables user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + quotaTariffCreate + Creates a quota tariff for a resource. + false + 4.18.0.0 + + + name + Quota tariff's name + true + string + + + usagetype + Integer value for the usage type of the resource. + true + integer + + + value + The quota tariff value of the resource as per the default unit. + true + double + + + activationrule + Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. + false + string + + + description + Quota tariff's description. + false + string + + + enddate + The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2009-06-03. + false + date + + + startdate + The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. Inform null to use the current date. + false + date + + + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + uuid + uuid + string + + + false + + + suspendProject + Suspends a project + true + 3.0.0 + + + id + id of the project to be suspended + true + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getApiLimit + Get API limit count for the caller + false + + + + account + the account name of the api remaining count + string + + + accountid + the account uuid of the api remaining count + string + + + apiAllowed + currently allowed number of apis + int + + + apiIssued + number of api already issued + int + + + expireAfter + seconds left to reset counters + long + + + false + + + deleteStorageNetworkIpRange + Deletes a storage network IP Range. + true + 3.0.0 + + + id + the uuid of the storage network ip range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addVmwareDc + Adds a Vmware datacenter to specified zone + false + + + name + Name of Vmware datacenter to be added to specified zone. + true + string + + + vcenter + The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + true + string + + + zoneid + The Zone ID. + true + uuid + + + password + The password for specified username. + false + string + + + username + The Username required to connect to resource. + false + string + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + updateIpv6FirewallRule + Updates Ipv6 firewall rule with specified ID + true + + + id + the ID of the ipv6 firewall rule + true + uuid + + + cidrlist + the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + endport + the ending port of Ipv6 firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the Ipv6 firewall rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + protocol + the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + false + string + + + startport + the starting port of Ipv6 firewall rule + false + integer + + + traffictype + the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateIsoPermissions + Updates ISO permissions + false + + + id + the template ID + true + uuid + + + accounts + a comma delimited list of accounts within caller's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + isextractable + true if the template/iso is extractable, false other wise. Can be set only by root admin + false + boolean + + + isfeatured + true for featured template/iso, false otherwise + false + boolean + + + ispublic + true for public template/iso, false for private templates/isos + false + boolean + + + op + permission operator (add, remove, reset) + false + string + + + projectids + a comma delimited list of projects. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVPCOffering + Deletes VPC offering + true + + + id + the ID of the VPC offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkACL + Deletes a network ACL + true + + + id + the ID of the network ACL + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricTag + create Tungsten-Fabric tag + true + + + tagtype + Tungsten-Fabric tag type + true + string + + + tagvalue + Tungsten-Fabric tag value + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + addOpenDaylightController + Adds an OpenDyalight controler + true + + + password + Credential to access the OpenDaylight API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + Api URL of the OpenDaylight Controller. + true + string + + + username + Username to access the OpenDaylight API + true + string + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + createZone + Creates a Zone. + false + + + dns1 + the first DNS for the Zone + true + string + + + internaldns1 + the first internal DNS for the Zone + true + string + + + name + the name of the Zone + true + string + + + networktype + network type of the zone, can be Basic or Advanced + true + string + + + allocationstate + Allocation state of this Zone for allocation of new resources + false + string + + + dns2 + the second DNS for the Zone + false + string + + + domain + Network domain name for the networks in the zone + false + string + + + domainid + the ID of the containing domain, null for public zones + false + uuid + + + guestcidraddress + the guest CIDR address for the Zone + false + string + + + internaldns2 + the second internal DNS for the Zone + false + string + + + ip6dns1 + the first DNS for IPv6 network in the Zone + false + string + + + ip6dns2 + the second DNS for IPv6 network in the Zone + false + string + + + isedge + true if the zone is an edge zone, false otherwise + false + 4.18.0 + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + false + boolean + + + securitygroupenabled + true if network is security group enabled, false otherwise + false + boolean + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listDomainChildren + Lists all children domains belonging to a specified domain + false + + + id + list children domain by parent domain ID. + false + uuid + + + isrecursive + to return the entire tree, use the value "true". To return the first level children, use the value "false". + false + boolean + + + keyword + List by keyword + false + string + + + listall + 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 + false + boolean + + + name + list children domains by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for domains + false + boolean + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + getVMPassword + Returns an encrypted password for the VM + false + + + id + The ID of the virtual machine + true + uuid + + + + + encryptedpassword + The base64 encoded encrypted password of the VM + string + + + false + + + assignToGlobalLoadBalancerRule + Assign load balancer rule or list of load balancer rules to a global load balancer rules. + true + + + id + the ID of the global load balancer rule + true + uuid + + + loadbalancerrulelist + the list load balancer rules that will be assigned to global load balancer rule + true + list + list + + + gslblbruleweightsmap + Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10' + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addImageStoreS3 + Adds S3 Image Store + false + 4.7.0 + + + accesskey + S3 access key + true + string + + + bucket + Name of the storage bucket + true + string + + + endpoint + S3 endpoint + true + string + + + secretkey + S3 secret key + true + string + + + connectiontimeout + Connection timeout (milliseconds) + false + integer + + + connectionttl + Connection TTL (milliseconds) + false + integer + + + maxerrorretry + Maximum number of times to retry on error + false + integer + + + s3signer + Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType + false + string + + + sockettimeout + Socket timeout (milliseconds) + false + integer + + + usehttps + Use HTTPS instead of HTTP + false + boolean + + + usetcpkeepalive + Whether TCP keep-alive is used + false + boolean + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + importUnmanagedInstance + Import unmanaged virtual machine from a given cluster. + true + 4.14.0 + + + clusterid + the cluster ID + true + uuid + + + name + the name of the instance as it is known to the hypervisor + true + string + + + serviceofferingid + the service offering for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping using keys disk and diskOffering + false + map + map + + + details + used to specify the custom parameters. + false + map + map + + + displayname + the display name of the instance + false + string + + + domainid + import instance to the domain specified + false + uuid + + + forced + VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated + false + boolean + + + hostname + the host name of the instance + false + string + + + migrateallowed + vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool + false + boolean + + + nicipaddresslist + VM nic to ip address mapping using keys nic, ip4Address + false + map + map + + + nicnetworklist + VM nic to network id mapping using keys nic and network + false + map + map + + + projectid + import instance for the project + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + uploadTemplateDirectDownloadCertificate + Upload a certificate for HTTPS direct template download on KVM hosts + false + 4.11.0 + + + certificate + SSL certificate + true + string + + + hypervisor + Hypervisor type + true + string + + + name + Name for the uploaded certificate + true + string + + + zoneid + Zone to upload certificate + true + uuid + + + hostid + (optional) the host ID to upload certificate + false + uuid + + + + + id + the direct download certificate id + string + + + alias + the direct download certificate alias + string + + + hostsmap + the hosts where the certificate is uploaded to + list + + + hypervisor + the hypervisor of the hosts where the certificate is uploaded + string + + + issuer + the direct download certificate issuer + string + + + serialnum + the direct download certificate serial num + string + + + subject + the direct download certificate subject + string + + + validity + the direct download certificate issuer + string + + + version + the direct download certificate version + string + + + zoneid + the zone id where the certificate is uploaded + string + + + zonename + the zone name where the certificate is uploaded + string + + + false + + + createPhysicalNetwork + Creates a physical network + true + 3.0.0 + + + name + the name of the physical network + true + string + + + zoneid + the Zone ID for the physical network + true + uuid + + + broadcastdomainrange + the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic + false + string + + + domainid + domain ID of the account owning a physical network + false + uuid + + + isolationmethods + the isolation method for the physical network[VLAN/L3/GRE] + false + list + list + + + networkspeed + the speed for the physical network[1G/10G] + false + string + + + tags + Tag the physical network + false + list + list + + + vlan + the VLAN for the physical network + false + string + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + listAutoScaleVmGroups + Lists autoscale vm groups. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the autoscale vm group + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the loadbalancer + false + uuid + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + page + false + integer + + + pagesize + false + integer + + + policyid + the ID of the policy + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vmprofileid + the ID of the profile + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + updatePod + Updates a Pod. + false + + + id + the ID of the Pod + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + endip + the ending IP address for the Pod + false + string + + + gateway + the gateway for the Pod + false + string + + + name + the name of the Pod + false + string + + + netmask + the netmask of the Pod + false + string + + + startip + the starting IP address for the Pod + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + attachIso + Attaches an ISO to a virtual machine. + true + + + id + the ID of the ISO file + true + uuid + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + forced + If true, ejects existing ISO before attaching on VMware. Default: false + false + 4.15.1 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + ldapRemove + (Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site. + false + 3.0.1 + + + + binddn + Specify the distinguished name of a user with the search permission on the directory + string + + + bindpass + DN password + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + string + + + port + Specify the LDAP port if required, default is 389 + string + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL + string + + + true + + + createUser + Creates a user for an account that already exists + false + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + true + string + + + email + email + true + string + + + firstname + firstname + true + string + + + lastname + lastname + true + string + + + password + Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Unique username. + true + string + + + domainid + Creates the user under the specified domain. Has to be accompanied with the account parameter + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + createVpnGateway + Creates site to site vpn local gateway + true + + + vpcid + public ip address id of the vpn gateway + true + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + addResourceDetail + Adds detail for the Resource. + true + + + details + Map of (key/value pairs) + true + map + map + + + resourceid + resource id to create the details for + true + string + + + resourcetype + type of the resource + true + string + + + fordisplay + pass false if you want this detail to be disabled for the regular user. True by default + false + 4.4 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVpnUsers + Lists vpn users + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + The uuid of the Vpn user + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + username + the username of the vpn user. + false + string + + + + + id + the vpn userID + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'. + string + + + username + the username of the vpn user + string + + + false + + + registerUserData + Register a new userdata. + false + 4.18 + + + name + Name of the userdata + true + string + + + userdata + Base64 encoded userdata content. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + true + string + + + account + an optional account for the userdata. Must be used with domainId. + false + string + + + domainid + an optional domainId for the userdata. If the account parameter is used, domainId must also be used. + false + uuid + + + params + comma separated list of variables declared in userdata content + false + string + + + projectid + an optional project for the userdata + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteIpForwardingRule + Deletes an IP forwarding rule + true + + + id + the ID of the forwarding rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addRegion + Adds a Region + false + + + id + Id of the Region + true + integer + + + endpoint + Region service endpoint + true + string + + + name + Name of the region + true + string + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + generateUsageRecords + Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed + false + + + enddate + End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + true + date + + + startdate + Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + true + date + + + domainid + List events for the specified domain. + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateRolePermission + Updates a role permission order + false + 4.9.0 + + + roleid + ID of the role + true + uuid + + + permission + Rule permission, can be: allow or deny + false + 4.11 + string + + + ruleid + Role permission rule id + false + 4.11 + uuid + + + ruleorder + The parent role permission uuid, use 0 to move this rule at the top of the list + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAccounts + Lists accounts and provides detailed account information for listed accounts + false + + + accounttype + list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user). + false + integer + + + details + comma separated list of account details requested, value can be a list of [ all, resource, min] + false + list + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list account by account ID + false + uuid + + + iscleanuprequired + list accounts by cleanuprequired attribute (values are true or false) + false + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list account by account name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for accounts + false + boolean + + + state + list accounts by state. Valid states are enabled, disabled, and locked. + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + destroyRouter + Destroys a router. + true + + + id + the ID of the router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listImageStores + Lists image stores. + false + 4.2.0 + + + id + the ID of the storage pool + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the image store + false + string + + + page + false + integer + + + pagesize + false + integer + + + protocol + the image store protocol + false + string + + + provider + the image store provider + false + string + + + readonly + read-only status of the image store + false + 4.15.0 + boolean + + + zoneid + the Zone ID for the image store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + deleteAccount + Deletes a account, and all users associated with this account + true + + + id + Account id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableOutOfBandManagementForCluster + Disables out-of-band management for a cluster + true + 4.9.0 + + + clusterid + the ID of the cluster + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + activateProject + Activates a project + true + 3.0.0 + + + id + id of the project to be modified + true + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteSslCert + Delete a certificate to CloudStack + false + + + id + Id of SSL certificate + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteAlerts + Delete one or more alerts. + false + + + enddate + end date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the alerts + false + list + list + + + startdate + start date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + delete by alert type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createAutoScaleVmProfile + Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature. + true + + + serviceofferingid + the service offering of the auto deployed virtual machine + true + uuid + + + templateid + the template of the auto deployed virtual machine + true + uuid + + + zoneid + availability zone for the auto deployed virtual machine + true + uuid + + + account + account that will own the autoscale VM profile + false + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + false + uuid + + + counterparam + counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161 + false + map + map + + + domainid + domain ID of the account owning a autoscale VM profile + false + uuid + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is expunged + false + integer + + + fordisplay + an optional field, whether to the display the profile to the end user or not + false + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. +Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 . +Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". + false + map + map + + + projectid + an optional project for the autoscale VM profile + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + 4.18.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18.1 + map + + + userdataid + the ID of the Userdata + false + 4.18.1 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + domainpath + path of the domain to which the vm profile belongs + 4.19.2.0 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base64 encoded VM user data + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.1 + string + + + userdataid + the id of userdata used for the VM + 4.18.1 + string + + + userdataname + the name of userdata used for the VM + 4.18.1 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.1 + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + registerOauthProvider + Register the OAuth2 provider in CloudStack + false + 4.19.0 + + + clientid + Client ID pre-registered in the specific OAuth provider + true + string + + + description + Description of the OAuth Provider + true + string + + + provider + Name of the provider from the list of OAuth providers supported in CloudStack + true + string + + + redirecturi + Redirect URI pre-registered in the specific OAuth provider + true + string + + + secretkey + Secret Key pre-registered in the specific OAuth provider + true + string + + + details + Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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 + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listLBStickinessPolicies + Lists load balancer stickiness policies. + false + 3.0.0 + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer stickiness policy + false + uuid + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the load balancer rule + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + addUcsManager + Adds a Ucs manager + false + + + password + the password of UCS + true + string + + + url + the name of UCS url + true + string + + + username + the username of UCS + true + string + + + zoneid + the Zone id for the ucs manager + true + uuid + + + name + the name of UCS manager + false + string + + + + + id + the ID of the ucs manager + string + + + name + the name of ucs manager + string + + + url + the url of ucs manager + string + + + zoneid + the zone ID of ucs manager + string + + + false + + + deleteVnfTemplate + Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected. + true + 4.19.0 + + + id + the ID of the template + true + uuid + + + forced + Force delete a template. + false + 4.9+ + boolean + + + zoneid + the ID of zone of the template + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetscalerLoadBalancers + lists netscaler load balancer devices + false + + + keyword + List by keyword + false + string + + + lbdeviceid + netscaler load balancer device ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + createInstanceGroup + Creates a vm group + false + + + name + the name of the instance group + true + string + + + account + the account of the instance group. The account parameter must be used with the domainId parameter. + false + string + + + domainid + the domain ID of account owning the instance group + false + uuid + + + projectid + The project of the instance group + false + uuid + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + domainpath + path of the Domain the instance group belongs to + 4.19.2.0 + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + createLoadBalancer + Creates an internal load balancer + true + 4.2.0 + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + true + string + + + instanceport + the TCP port of the virtual machine where the network traffic will be load balanced to + true + integer + + + name + name of the load balancer + true + string + + + networkid + The guest network the load balancer will be created for + true + uuid + + + scheme + the load balancer scheme. Supported value in this release is Internal + true + string + + + sourceipaddressnetworkid + the network id of the source ip address + true + uuid + + + sourceport + the source port the network traffic will be load balanced from + true + integer + + + description + the description of the load balancer + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + sourceipaddress + the source IP address the network traffic will be load balanced from + false + string + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + domainpath + path of the domain to which the Load Balancer belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateBackupSchedule + Updates a user-defined VM backup schedule + false + 4.14.0 + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + schedule + custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + date + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + addPaloAltoFirewall + Adds a Palo Alto firewall device + true + + + networkdevicetype + supports only PaloAltoFirewall + true + string + + + password + Credentials to reach Palo Alto firewall device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the Palo Alto appliance. + true + string + + + username + Credentials to reach Palo Alto firewall device + true + string + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + createPrivateGateway + Creates a private gateway + true + 4.17.0 + + + gateway + the gateway of the Private gateway + true + string + + + ipaddress + the IP address of the Private gateaway + true + string + + + netmask + the netmask of the Private gateway + true + string + + + vpcid + the VPC network belongs to + true + uuid + + + aclid + the ID of the network ACL + false + uuid + + + associatednetworkid + The isolated network this private gateway is associated to. + false + 4.17.0 + uuid + + + bypassvlanoverlapcheck + when true bypasses VLAN id/range overlap check during private gateway creation + false + boolean + + + networkofferingid + the uuid of the network offering to use for the private gateways network connection + false + uuid + + + physicalnetworkid + the Physical Network ID the network belongs to + false + uuid + + + sourcenatsupported + source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported + false + boolean + + + vlan + the network implementation uri for the private gateway + false + string + + + + + id + the id of the private gateway + string + + + account + the account associated with the private gateway + string + + + aclid + ACL Id set for private gateway + string + + + aclname + ACL name set for private gateway + string + + + domain + the domain associated with the private gateway + string + + + domainid + the ID of the domain associated with the private gateway + string + + + domainpath + path of the domain to which the private gateway belongs + 4.19.2.0 + string + + + gateway + the gateway + string + + + ipaddress + the private gateway's ip address + string + + + netmask + the private gateway's netmask + string + + + physicalnetworkid + the physical network id + string + + + project + the project name of the private gateway + string + + + projectid + the project id of the private gateway + string + + + sourcenatsupported + Source Nat enable status + boolean + + + state + State of the gateway, can be Creating, Ready, Deleting + string + + + vlan + the network implementation uri for the private gateway + string + + + vpcid + VPC id the private gateway belongs to + string + + + vpcname + VPC name the private gateway belongs to + 4.13.2 + string + + + zoneid + zone id of the private gateway + string + + + zonename + the name of the zone the private gateway belongs to + string + + + false + + + uploadSslCert + Upload a certificate to CloudStack + false + + + certificate + SSL certificate + true + string + + + name + Name for the uploaded certificate + true + string + + + privatekey + Private key + true + string + + + account + account that will own the SSL certificate + false + string + + + certchain + Certificate chain of trust + false + string + + + domainid + domain ID of the account owning the SSL certificate + false + uuid + + + enabledrevocationcheck + Enables revocation checking for certificates + false + 4.15 + boolean + + + password + Password for the private key + false + string + + + projectid + an optional project for the SSL certificate + false + uuid + + + + + id + SSL certificate ID + string + + + account + account for the certificate + string + + + certchain + certificate chain + string + + + certificate + certificate + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + fingerprint + certificate fingerprint + string + + + loadbalancerrulelist + List of loabalancers this certificate is bound to + list + + + name + name + string + + + project + the project name of the certificate + string + + + projectid + the project id of the certificate + string + + + false + + + deleteFirewallRule + Deletes a firewall rule + true + + + id + the ID of the firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateOauthProvider + Updates the registered OAuth provider details + false + 4.19.0 + + + id + id of the OAuth provider to be updated + true + uuid + + + clientid + Client ID pre-registered in the specific OAuth provider + false + string + + + description + Description of the OAuth Provider + false + string + + + enabled + OAuth provider will be enabled or disabled based on this value + false + boolean + + + redirecturi + Redirect URI pre-registered in the specific OAuth provider + false + string + + + secretkey + Secret Key pre-registered in the specific OAuth provider + false + string + + + + + id + ID of the provider + string + + + clientid + Client ID registered in the OAuth provider + string + + + description + Description of the provider registered + string + + + enabled + Whether the OAuth provider is enabled or not + boolean + + + name + Name of the provider + string + + + provider + Name of the provider + string + + + redirecturi + Redirect URI registered in the OAuth provider + string + + + secretkey + Secret key registered in the OAuth provider + string + + + false + + + createVpnCustomerGateway + Creates site to site vpn customer gateway + true + + + cidrlist + guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,). + true + string + + + esppolicy + ESP policy of the customer gateway + true + string + + + gateway + public ip address id of the customer gateway + true + string + + + ikepolicy + IKE policy of the customer gateway + true + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes. + true + string + + + account + the account associated with the gateway. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain. + false + uuid + + + dpd + If DPD is enabled for VPN connection + false + boolean + + + esplifetime + Lifetime of phase 2 VPN connection to the customer gateway, in seconds + false + long + + + forceencap + Force Encapsulation for NAT traversal + false + boolean + + + ikelifetime + Lifetime of phase 1 VPN connection to the customer gateway, in seconds + false + long + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike + false + 4.15.1 + string + + + name + name of this customer gateway + false + string + + + projectid + create site-to-site VPN customer gateway for the project + false + 4.6 + uuid + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + false + 4.15.1 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + removeAnnotation + remove an annotation. + false + 4.11 + + + id + the id of the annotation + true + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + addBaremetalHost + add a baremetal host + false + + + hypervisor + hypervisor type of the host + true + string + + + podid + the Pod ID for the host + true + uuid + + + url + the host URL + true + string + + + zoneid + the Zone ID for the host + true + uuid + + + allocationstate + Allocation state of this Host for allocation of new resources + false + string + + + clusterid + the cluster ID for the host + false + uuid + + + clustername + the cluster name for the host + false + string + + + hosttags + list of tags to be added to the host + false + list + list + + + ipaddress + ip address intentionally allocated to this host after provisioning + false + string + + + password + the password for the host; required to be passed for hypervisors other than VMWare + false + string + + + username + the username for the host; required to be passed for hypervisors other than VMWare + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteRolePermission + Deletes a role permission + false + 4.9.0 + + + id + ID of the role permission + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateVMSchedule + Update VM Schedule. + false + 4.19.0 + + + id + ID of VM schedule + true + uuid + + + description + Name of the schedule + false + string + + + enabled + Enable VM schedule + false + boolean + + + enddate + end date after which the schedule becomes inactiveUse format "yyyy-MM-dd hh:mm:ss") + false + date + + + schedule + Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month' + false + string + + + startdate + start date from which the schedule becomes activeUse format "yyyy-MM-dd hh:mm:ss") + false + date + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + false + string + + + + + id + the ID of VM schedule + string + + + action + Action + action + + + created + Date when the schedule was created + date + + + description + Description of VM schedule + string + + + enabled + VM schedule is enabled + boolean + + + enddate + Date after which the schedule becomes inactive + date + + + schedule + Cron formatted VM schedule + string + + + startdate + Date from which the schedule is active + date + + + timezone + Timezone of the schedule + string + + + virtualmachineid + ID of virtual machine + string + + + false + + + listConfigurationGroups + Lists all configuration groups (primarily used for UI). + false + 4.18.0 + + + group + lists configuration group by group name + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + description + the description of the configuration group + string + + + name + the name of the configuration group + string + + + precedence + the precedence of the configuration group + long + + + subgroup(*) + the subgroups of the configuration group + + + name + the name of the configuration subgroup + string + + + precedence + the precedence of the configuration subgroup + long + + + list + + + false + + + releasePodIpAddress + Releases a Pod IP back to the Pod + false + + + id + UUID of the Pod IP + true + long + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateRemoteAccessVpn + Updates remote access vpn + true + 4.4 + + + id + id of the remote access vpn + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + destroyVirtualMachine + Destroys a virtual machine. Once destroyed, only the administrator can recover it. + true + + + id + The ID of the virtual machine + true + uuid + + + expunge + If true is passed, the vm is expunged immediately. False by default. + false + 4.2.1 + boolean + + + volumeids + Comma separated list of UUIDs for volumes that will be deleted + false + list + 4.12.0 + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + assignVirtualMachineToBackupOffering + Assigns a VM to a backup offering + true + 4.14.0 + + + backupofferingid + ID of the backup offering + true + uuid + + + virtualmachineid + ID of the virtual machine + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + startVirtualMachine + Starts a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + bootintosetup + Boot into hardware setup menu or not + false + 4.15.0.0 + boolean + + + clusterid + destination Cluster ID to deploy the VM to - parameter available for root admin only + false + uuid + + + considerlasthost + True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process. + false + 4.18.0 + boolean + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + 3.0.1 + uuid + + + podid + destination Pod ID to deploy the VM to - parameter available for root admin only + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listResourceIcon + Lists the resource icon for the specified resource(s) + false + 4.16.0.0 + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + base64image + base64 representation of resource icon + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + resourceobjecttype + + + false + + + createPod + Creates a new Pod. + false + + + name + the name of the Pod + true + string + + + zoneid + the Zone ID in which the Pod will be created + true + uuid + + + allocationstate + Allocation state of this Pod for allocation of new resources + false + string + + + endip + the ending IP address for the Pod + false + string + + + gateway + the gateway for the Pod + false + string + + + netmask + the netmask for the Pod + false + string + + + startip + the starting IP address for the Pod + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + removeRawUsageRecords + Safely removes raw records from cloud_usage table + false + 4.6.0 + + + interval + 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 + true + integer + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + provisionCertificate + Issues and propagates client certificate on a connected host/agent using configured CA plugin + true + 4.11.0 + + + hostid + The host/agent uuid to which the certificate has to be provisioned (issued and propagated) + true + uuid + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + reconnect + Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVirtualMachinesMetrics + Lists VM metrics + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + clusterid + the cluster ID + false + uuid + + + details + comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hostid + the host ID + false + uuid + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. + false + 4.19.0 + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + storageid + the storage ID where vm's volumes belong to + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + cputotal + the total cpu capacity in Ghz + string + + + diskiopstotal + the total disk iops + long + + + diskread + disk read in MiB + string + + + diskwrite + disk write in MiB + string + + + memorytotal + the total memory capacity in GiB + string + + + networkread + network read in MiB + string + + + networkwrite + network write in MiB + string + + + false + + + listHosts + Lists hosts. + false + + + clusterid + lists hosts existing in particular cluster + false + uuid + + + details + comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats] + false + list + list + + + hahost + if true, list only hosts dedicated to HA + false + boolean + + + hypervisor + hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator + false + string + + + id + the id of the host + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the host + false + string + + + outofbandmanagementenabled + list hosts for which out-of-band management is enabled + false + boolean + + + outofbandmanagementpowerstate + list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown] + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID for the host + false + uuid + + + resourcestate + 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] + false + string + + + state + the state of the host + false + string + + + type + the host type + false + string + + + virtualmachineid + lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM + false + uuid + + + zoneid + the Zone ID for the host + false + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteStoragePool + Deletes a storage pool. + false + + + id + Storage pool id + true + uuid + + + forced + Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal) + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteGuestNetworkIpv6Prefix + Deletes an existing guest network IPv6 prefix. + true + 4.17.0.0 + + + id + Id of the guest network IPv6 prefix + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateStoragePool + Updates a storage pool. + false + 3.0.0 + + + id + the Id of the storage pool + true + uuid + + + capacitybytes + bytes CloudStack can provision from this storage pool + false + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + false + long + + + details + the details for the storage pool + false + map + 4.19.0 + map + + + enabled + false to disable the pool for allocation of new volumes, true to enable it back. + false + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + false + boolean + + + name + Change the name of the storage pool + false + 4.15 + string + + + tags + comma-separated list of tags for the storage pool + false + list + list + + + url + the URL of the storage pool + false + 4.19.0 + string + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTungstenFabricTag + Lists Tungsten-Fabric tags + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + keyword + List by keyword + false + string + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + nicuuid + the uuid of Tungsten-Fabric nic + false + string + + + page + false + integer + + + pagesize + false + integer + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + taguuid + the uuid of Tungsten-Fabric tag + false + string + + + vmuuid + the uuid of Tungsten-Fabric vm + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + importLdapUsers + Import LDAP users + false + 4.3.0 + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + 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 + false + uuid + + + group + Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported. + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + moveDomain + Moves a domain and its children to a new parent domain. + false + 4.19.0.0 + + + domainid + The ID of the domain to be moved. + true + uuid + + + parentdomainid + The ID of the new parent domain of the domain to be moved. + true + uuid + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + listNetworks + Lists all available networks. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + acltype + list networks by ACL (access control list) type. Supported values are account and domain + false + string + + + associatednetworkid + List networks by associated networks. Only available if create a Shared network. + false + 4.17.0 + uuid + + + canusefordeploy + list networks available for VM deployment + false + boolean + + + displaynetwork + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvpc + the network belongs to VPC + false + boolean + + + id + list networks by ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issystem + true if network is system, false otherwise + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkfilter + possible values are "account", "domain", "accountdomain","shared", and "all". Default value is "all".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared). + false + 4.17.0 + string + + + networkofferingid + list networks by network offering ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + list networks by physical network id + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + restartrequired + list networks by restartRequired + false + boolean + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + showicon + flag to display the resource icon for networks + false + boolean + + + specifyipranges + true if need to list only networks which support specifying IP ranges + false + boolean + + + supportedservices + list networks supporting certain services + false + list + list + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + type of the traffic + false + string + + + type + the type of the network. Supported values are: isolated, l2, shared and all + false + string + + + vlan + the ID or VID of the network + false + 4.17.0 + string + + + vpcid + List networks by VPC + false + uuid + + + zoneid + the zone ID of the network + false + uuid + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + releaseIpAddress + Releases an IP address from the account. + false + 4.17 + + + id + the ID of the public IP address to release + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updatePodManagementNetworkIpRange + Updates a management network IP range. Only allowed when no IPs are allocated. + true + 4.16.0.0 + + + currentendip + The current ending IP address. + true + string + + + currentstartip + The current starting IP address. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + newendip + The new ending IP address. + false + string + + + newstartip + The new starting IP address. + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateFirewallRule + Updates firewall rule + true + 4.4 + + + id + the ID of the firewall rule + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + quotaIsEnabled + Return true if the plugin is enabled + false + 4.7.0 + + + + isenabled + is quota service enabled + boolean + + + false + + + deleteOauthProvider + Deletes the registered OAuth provider + false + 4.19.0 + + + id + id of the OAuth provider to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaEmailTemplateList + Lists all quota email templates + false + 4.7.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + templatetype + List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY + false + string + + + + + last_updated + Last date/time when template was updated + date + + + locale + The quota email template locale + string + + + templatebody + The quota email template content + string + + + templatesubject + The quota email template subject + string + + + templatetype + Template type + string + + + false + + + listHypervisors + List hypervisors + false + + + zoneid + the zone id for listing hypervisors. + false + uuid + + + + + name + Hypervisor name + string + + + false + + + listHostsMetrics + Lists hosts metrics + false + 4.9.3 + + + clusterid + lists hosts existing in particular cluster + false + uuid + + + details + comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats] + false + list + list + + + hahost + if true, list only hosts dedicated to HA + false + boolean + + + hypervisor + hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator + false + string + + + id + the id of the host + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the host + false + string + + + outofbandmanagementenabled + list hosts for which out-of-band management is enabled + false + boolean + + + outofbandmanagementpowerstate + list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown] + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID for the host + false + uuid + + + resourcestate + 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] + false + string + + + state + the state of the host + false + string + + + type + the host type + false + string + + + virtualmachineid + lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM + false + uuid + + + zoneid + the Zone ID for the host + false + uuid + + + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedghz + the total cpu allocated in Ghz + string + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpuloadaverage + the average cpu load the last minute + double + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotalghz + the total cpu capacity in Ghz + string + + + cpuusedghz + the total cpu used in Ghz + string + + + instances + instances on the host + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedgb + the total memory allocated in GiB + string + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotalgb + the total memory capacity in GiB + string + + + memoryusedgb + the total memory used in GiB + string + + + networkread + network read in GiB + string + + + networkwrite + network write in GiB + string + + + powerstate + out-of-band management power state + powerstate + + + systeminstances + system vm instances on the host + string + + + false + + + releaseDedicatedPod + Release the dedication for the pod + true + + + podid + the ID of the Pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + cancelShutdown + Cancels a triggered shutdown + false + 4.19.0 + + + managementserverid + the uuid of the management server + true + uuid + + + + + managementserverid + The id of the management server + long + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + listAffinityGroups + Lists affinity groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list the affinity group by the ID provided + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + lists affinity groups by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + type + lists affinity groups by type + false + string + + + virtualmachineid + lists affinity groups by virtual machine ID + false + uuid + + + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + false + + + registerSSHKeyPair + Register a public key in a keypair under a certain name + false + + + name + Name of the keypair + true + string + + + publickey + Public key material of the keypair + true + string + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the ssh key. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the ssh key + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the keypair + string + + + domain + the domain name of the keypair owner + string + + + domainid + the domain id of the keypair owner + string + + + fingerprint + Fingerprint of the public key + string + + + name + Name of the keypair + string + + + project + the project name of the keypair owner + string + + + projectid + the project id of the keypair owner + string + + + false + + + reserveIpAddress + Reserve a public IP to an account. + false + 4.17 + + + id + the ID of the public IP address to reserve + true + uuid + + + account + the account to reserve with this IP address + false + string + + + domainid + the ID of the domain to reserve with this IP address + false + uuid + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + boolean + + + projectid + the ID of the project to reserve with this IP address + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteEvents + Delete one or more events. + false + + + enddate + end date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the events + false + list + list + + + startdate + start date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + delete by event type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteIso + Deletes an ISO file. + true + + + id + the ID of the ISO file + true + uuid + + + zoneid + the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getSolidFireVolumeSize + Get the SF volume size including Hypervisor Snapshot Reserve + false + + + volumeid + Volume UUID + true + string + + + + + solidFireVolumeSize + SolidFire Volume Size Including Hypervisor Snapshot Reserve + long + + + false + + + listVPCOfferings + Lists VPC offerings + false + + + displaytext + list VPC offerings by display text + false + string + + + domainid + list VPC offerings available for VPC creation in specific domain + false + 4.18 + uuid + + + id + list VPC offerings by id + false + uuid + + + isdefault + true if need to list only default VPC offerings. Default value is false + false + boolean + + + keyword + List by keyword + false + string + + + name + list VPC offerings by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + state + list VPC offerings by state + false + string + + + supportedservices + list VPC offerings supporting certain services + false + list + list + + + zoneid + id of zone VPC offering is associated with + false + 4.13 + uuid + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + uploadVolume + Uploads a data disk. + true + + + format + the format for the volume. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume + true + string + + + url + the URL of where the volume is hosted. Possible URL include http:// and https:// + true + string + + + zoneid + the ID of the zone the volume is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + checksum + the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + diskofferingid + the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown. + false + uuid + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain. + false + uuid + + + imagestoreuuid + Image store uuid + false + string + + + projectid + Upload volume for the project + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + configureOutOfBandManagement + Configures a host's out-of-band management interface + false + 4.9.0 + + + address + the host management interface IP address + true + string + + + driver + the host management interface driver, for example: ipmitool + true + string + + + hostid + the ID of the host + true + uuid + + + password + the host management interface password + true + string + + + port + the host management interface port + true + string + + + username + the host management interface user + true + string + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listStorageTags + Lists storage tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the storage tag + string + + + name + the name of the storage tag + string + + + poolid + the pool ID of the storage tag + long + + + false + + + deleteVMSchedule + Delete VM Schedule. + false + 4.19.0 + + + virtualmachineid + ID of VM + true + uuid + + + id + ID of VM schedule + false + uuid + + + ids + IDs of VM schedule + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTemplatePermissions + List template visibility and all accounts that have permissions to view this template. + false + + + id + the template ID + true + uuid + + + + + id + the template ID + string + + + account + the list of accounts the template is available for + list + + + domainid + the ID of the domain to which the template belongs + string + + + ispublic + true if this template is a public template, false otherwise + boolean + + + projectids + the list of projects the template is available for + list + + + false + + + listAnnotations + Lists annotations. + false + 4.11 + + + annotationfilter + possible values are "self" and "all". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access + false + 4.16.0 + string + + + entityid + the id of the entity for which to show annotations + false + string + + + entitytype + the entity type + false + string + + + id + the id of the annotation + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + userid + optional: the id of the user of the annotation + false + 4.16.0 + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + addSwift + Adds Swift. + false + 3.0.0 + + + url + the URL for swift + true + string + + + account + the account for swift + false + string + + + key + key for the user for swift + false + string + + + username + the username for swift + false + string + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + updateVpnCustomerGateway + Update site to site vpn customer gateway + true + + + id + id of customer gateway + true + uuid + + + cidrlist + guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,). + true + string + + + esppolicy + ESP policy of the customer gateway + true + string + + + gateway + public ip address id of the customer gateway + true + string + + + ikepolicy + IKE policy of the customer gateway + true + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes. + true + string + + + account + the account associated with the gateway. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain. + false + uuid + + + dpd + If DPD is enabled for VPN connection + false + boolean + + + esplifetime + Lifetime of phase 2 VPN connection to the customer gateway, in seconds + false + long + + + forceencap + Force encapsulation for Nat Traversal + false + boolean + + + ikelifetime + Lifetime of phase 1 VPN connection to the customer gateway, in seconds + false + long + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike + false + 4.15.1 + string + + + name + name of this customer gateway + false + string + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + false + 4.15.1 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + listSnapshotPolicies + Lists snapshot policies. + false + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the snapshot policy + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + volumeid + the ID of the disk volume + false + uuid + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + zone + The list of zones in which snapshot backup is scheduled + 4.19.0 + set + + + false + + + applyTungstenFabricTag + apply Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + networkuuid + the uuid of networks + false + list + list + + + nicuuid + the uuid of nics + false + list + list + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + vmuuid + the uuid of vms + false + list + list + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateObjectStoragePool + Updates object storage pool + false + 4.19.0 + + + id + Object Store ID + true + uuid + + + name + the name for the object store + false + string + + + url + the url for the object store + false + string + + + + + id + the ID of the object store + string + + + name + the name of the object store + string + + + providername + the provider name of the object store + string + + + storagetotal + the total size of the object store + long + + + storageused + the object store currently used size + long + + + url + the url of the object store + string + + + false + + + stopRouter + Stops a router. + true + + + id + the ID of the router + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + lockAccount + This deprecated function used to locks an account. Look for the API DisableAccount instead + false + + + account + Locks the specified account. + true + string + + + domainid + Locks the specified account on this domain. + true + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + deleteProjectInvitation + Deletes project invitation + true + 3.0.0 + + + id + id of the invitation + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricFirewallPolicy + create Tungsten-Fabric firewall policy + true + + + name + Tungsten-Fabric firewall policy name + true + string + + + sequence + the sequence of Tungsten-Fabric firewall policy + true + integer + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + + + firewallrule + list Tungsten-Fabric firewall rule + list + + + name + Tungsten-Fabric firewall policy name + string + + + uuid + Tungsten-Fabric firewall policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateRegion + Updates a region + false + + + id + Id of region to update + true + integer + + + endpoint + updates region with this end point + false + string + + + name + updates region with this name + false + string + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + deleteTrafficType + Deletes traffic type of a physical network + true + 3.0.0 + + + id + traffic type id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listProjectRolePermissions + Lists a project's project role permissions + false + 4.15.0 + + + projectid + ID of the project + true + uuid + + + projectroleid + ID of the project role + false + uuid + + + + + id + the ID of the project role permission + string + + + projectid + the ID of the project + string + + + projectroleid + the ID of the project role to which the role permission belongs + string + + + projectrolename + the name of the project role to which the role permission belongs + string + + + false + + + listLdapConfigurations + Lists all LDAP configurations + false + 4.2.0 + + + domainid + linked domain + false + uuid + + + hostname + Hostname + false + string + + + keyword + List by keyword + false + string + + + listall + If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain + false + 4.13.2 + boolean + + + page + false + integer + + + pagesize + false + integer + + + port + Port + false + integer + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port the ldap server is running on + int + + + false + + + createRemoteAccessVpn + Creates a l2tp/ipsec remote access vpn + true + + + publicipid + public ip address id of the vpn server + true + uuid + + + account + an optional account for the VPN. Must be used with domainId. + false + string + + + domainid + an optional domainId for the VPN. If the account parameter is used, domainId must also be used. + false + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + iprange + the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server + false + string + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default + false + boolean + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + changeServiceForVirtualMachine + (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect. + false + + + id + The ID of the virtual machine + true + uuid + + + serviceofferingid + the service offering ID to apply to the virtual machine + true + uuid + + + automigrate + Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering + false + 4.17 + boolean + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + maxiops + New maximum number of IOPS for the custom disk offering + false + 4.17 + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + 4.17 + long + + + shrinkok + Verify OK to Shrink + false + 4.17 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + true + + + listTemplates + List all public, private, and privileged templates. + false + + + templatefilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + details + comma separated list of template details requested, value can be a list of [ all, min] + false + list + 4.15 + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + the template ID + false + uuid + + + ids + the IDs of the templates, mutually exclusive with id + false + list + 4.9 + list + + + imagestoreid + ID of the image or image cache store + false + 4.19 + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list VNF templates or not; true if need to list VNF templates, false otherwise. + false + 4.19.0 + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the template name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parenttemplateid + list datadisk templates by parent template id + false + 4.4 + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the templates + false + boolean + + + showremoved + show removed templates as well + false + boolean + + + showunique + If set to true, list only unique templates across zones + false + 4.13.2 + boolean + + + storageid + ID of the storage pool + false + 4.19 + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templatetype + the type of the template + false + 4.19.0 + string + + + zoneid + list templates by zoneId + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listGuestOsMapping + Lists all available OS mappings for given hypervisor + false + 4.4.0 + + + hypervisor + list Guest OS mapping by hypervisor + false + string + + + hypervisorversion + list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter + false + string + + + id + list mapping by its UUID + false + uuid + + + keyword + List by keyword + false + string + + + osdisplayname + list Guest OS mapping by OS display name + false + string + + + osnameforhypervisor + list Guest OS mapping by OS mapping name with hypervisor + false + string + + + ostypeid + list mapping by Guest OS Type UUID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + createTungstenFabricPolicy + create Tungsten-Fabric policy + true + + + name + Tungsten-Fabric policy name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createBucket + Creates a bucket in the specified object storage pool. + true + 4.19.0 + + + name + the name of the bucket + true + string + + + objectstorageid + Id of the Object Storage Pool where bucket is created + true + uuid + + + account + the account associated with the bucket. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain. + false + uuid + + + encryption + Enable bucket encryption + false + boolean + + + objectlocking + Enable object locking in bucket + false + boolean + + + policy + The Bucket access policy + false + string + + + projectid + the project associated with the bucket. Mutually exclusive with account parameter + false + uuid + + + quota + Bucket Quota in GB + false + integer + + + versioning + Enable bucket versioning + false + boolean + + + + + id + ID of the Bucket + string + + + accesskey + Bucket Access Key + string + + + account + the account associated with the Bucket + string + + + created + the date the Bucket was created + date + + + domain + the domain associated with the bucket + string + + + domainid + the ID of the domain associated with the bucket + string + + + domainpath + path of the domain to which the bucket belongs + 4.19.2.0 + string + + + encryption + Bucket Encryption + boolean + + + name + name of the Bucket + string + + + objectlocking + Bucket Object Locking + boolean + + + objectstorageid + id of the object storage hosting the Bucket; returned to admin user only + string + + + objectstore + Name of the object storage hosting the Bucket; returned to admin user only + string + + + policy + Bucket Access Policy + string + + + project + the project name of the bucket + string + + + projectid + the project id of the bucket + string + + + provider + Object storage provider + string + + + quota + Bucket Quota in GB + integer + + + size + Total size of objects in Bucket + long + + + state + State of the Bucket + string + + + url + Bucket URL + string + + + usersecretkey + Bucket Secret Key + string + + + versioning + Bucket Versioning + boolean + + + false + + + listPhysicalNetworks + Lists physical networks + false + 3.0.0 + + + id + list physical network by id + false + uuid + + + keyword + List by keyword + false + string + + + name + search by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the Zone ID for the physical network + false + uuid + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + deleteBrocadeVcsDevice + delete a Brocade VCS Switch + true + + + vcsdeviceid + Brocade Switch ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listFirewallRules + Lists all firewall rules for an IP address. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the firewall services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list firewall rules for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + extractIso + Extracts an ISO + true + + + id + the ID of the ISO file + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + url + the URL to which the ISO would be extracted + false + string + + + zoneid + the ID of the zone where the ISO is originally located + false + uuid + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + createAffinityGroup + Creates an affinity/anti-affinity group + true + + + name + name of the affinity group + true + string + + + type + Type of the affinity group from the available affinity/anti-affinity group types + true + string + + + account + an account for the affinity group. Must be used with domainId. + false + string + + + description + optional description of the affinity group + false + string + + + domainid + domainId of the account owning the affinity group + false + uuid + + + projectid + create affinity group for project + false + uuid + + + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + false + + + oauthlogin + Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired. + false + 4.19.0 + + + email + Email id with which user tried to login using OAuth provider + true + string + + + provider + Name of the provider + true + string + + + domain + Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed. + false + string + + + domainId + The id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precedence. + false + long + + + secretcode + Code that is provided by OAuth provider (Eg. google, github) after successful login + false + string + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + listInternalLoadBalancerElements + Lists all available Internal Load Balancer elements. + false + 4.2.0 + + + enabled + list internal load balancer elements by enabled state + false + boolean + + + id + list internal load balancer elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list internal load balancer elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + getHypervisorGuestOsNames + Gets the guest OS names in the hypervisor + true + 4.19.0 + + + hypervisor + Hypervisor type. One of : VMware, XenServer + true + string + + + hypervisorversion + Hypervisor version to get the guest os names (atleast one hypervisor host with the version specified must be available) + true + string + + + keyword + Keyword for guest os name + false + string + + + + + guestoscount + the guest OS count of the hypervisor + integer + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for guest os names + string + + + guestoslist(*) + the guest OS list of the hypervisor + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + list + + + false + + + createTungstenFabricProvider + Create Tungsten-Fabric provider in cloudstack + false + + + name + Tungsten-Fabric provider name + true + string + + + tungstengateway + Tungsten-Fabric provider gateway + true + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + true + string + + + zoneid + the ID of zone + true + uuid + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + false + string + + + tungstenproviderport + Tungsten-Fabric provider port + false + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + false + string + + + + + name + Tungsten-Fabric provider name + string + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + tungstengateway + Tungsten-Fabric provider gateway + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + string + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + string + + + tungstenproviderport + Tungsten-Fabric provider port + string + + + tungstenprovideruuid + Tungsten-Fabric provider uuid + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + enableHAForCluster + Enables HA cluster-wide + true + 4.11 + + + clusterid + ID of the cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + rebootVirtualMachine + Reboots a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + bootintosetup + Boot into hardware setup menu or not + false + 4.15.0.0 + boolean + + + forced + Force reboot the VM (VM is Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addVirtualMachinesToKubernetesCluster + Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters. + false + 4.19.0 + + + id + the ID of the Kubernetes cluster + true + uuid + + + virtualmachineids + the IDs of the VMs to add to the cluster + true + list + list + + + iscontrolnode + Is control node or not? Defaults to false. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricLogicalRouter + list Tungsten-Fabric logical router + false + + + keyword + List by keyword + false + string + + + logicalrouteruuid + the uuid of Tungsten-Fabric logical router + false + string + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listBackupOfferings + Lists backup offerings + false + 4.14.0 + + + id + The backup offering ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + The zone ID + false + uuid + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + addGuestOsMapping + Adds a guest OS name to hypervisor OS name mapping + true + 4.4.0 + + + hypervisor + Hypervisor type. One of : XenServer, KVM, VMWare + true + string + + + hypervisorversion + Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version + true + string + + + osnameforhypervisor + OS name specific to the hypervisor + true + string + + + forced + Forces add user defined guest os mapping, overrides any existing user defined mapping + false + 4.19.0 + boolean + + + osdisplayname + Display Name of Guest OS standard type. Either Display Name or UUID must be passed + false + string + + + osmappingcheckenabled + When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.) + false + 4.19.0 + boolean + + + ostypeid + UUID of Guest OS type. Either the UUID or Display Name must be passed + false + uuid + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + listVnfTemplates + List all public, private, and privileged VNF templates. + false + 4.19.0 + + + templatefilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + details + comma separated list of template details requested, value can be a list of [ all, min] + false + list + 4.15 + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + the template ID + false + uuid + + + ids + the IDs of the templates, mutually exclusive with id + false + list + 4.9 + list + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list VNF templates or not; true if need to list VNF templates, false otherwise. + false + 4.19.0 + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the template name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parenttemplateid + list datadisk templates by parent template id + false + 4.4 + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the templates + false + boolean + + + showremoved + show removed templates as well + false + boolean + + + showunique + If set to true, list only unique templates across zones + false + 4.13.2 + boolean + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templatetype + the type of the template + false + 4.19.0 + string + + + zoneid + list templates by zoneId + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deployVnfAppliance + Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template. + true + 4.19.0 + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter + false + list + list + + + bootintosetup + Boot into hardware setup or not (ignored if startVm = false, only valid for vmware) + false + 4.15.0.0 + boolean + + + bootmode + Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + boottype + Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + copyimagetags + if true the image tags (if any) will be copied to the VM, default value is false + false + 4.13 + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter + false + map + 4.11 + map + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + details + used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details + false + map + 4.3 + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + diskofferingid + the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created. + false + uuid + + + displayname + an optional user generated name for the virtual machine + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + 4.2 + boolean + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain. + false + uuid + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable + false + 4.16 + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + an optional group for the virtual machine + false + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + uuid + + + hypervisor + the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call + false + string + + + iodriverpolicy + Controls specific policies on IO + false + string + + + iothreadsenabled + IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs. + false + boolean + + + ip6address + the ipv6 address for default vm's network + false + string + + + ipaddress + the ip address for default vm's network + false + string + + + iptonetworklist + ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid + false + map + map + + + keyboard + an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us + false + string + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs used to login to the virtual machine + false + list + 4.17 + list + + + macaddress + the mac address for default vm's network + false + string + + + name + host name for the virtual machine + false + string + + + networkids + list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter + false + list + list + + + nicmultiqueuenumber + The number of queues for multiqueue NICs. + false + 4.18 + integer + + + nicnetworklist + VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid + false + map + 4.15 + map + + + nicpackedvirtqueuesenabled + Enable packed virtqueues or not. + false + 4.18 + boolean + + + overridediskofferingid + the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id + false + 4.17 + uuid + + + password + The password of the virtual machine. If null, a random password will be generated for the VM. + false + 4.19.0.0 + string + + + projectid + Deploy vm for the project + false + uuid + + + properties + used to specify the vApp properties. + false + map + 4.15 + map + + + rootdisksize + Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.4 + long + + + securitygroupids + comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + size + the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId + false + long + + + startvm + true if start vm after creating; defaulted to true if not specified + false + boolean + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the Userdata + false + 4.18 + uuid + + + vnfcidrlist + the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0. + false + list + list + + + vnfconfiguremanagement + True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups. + false + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateNetworkOffering + Updates a network offering. + false + + + availability + the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required + false + string + + + displaytext + the display text of the network offering + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + id + the id of the network offering + false + uuid + + + keepaliveenabled + if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file. + false + boolean + + + maxconnections + maximum number of concurrent connections supported by the network offering + false + integer + + + name + the name of the network offering + false + string + + + sortkey + sort key of the network offering, integer + false + integer + + + state + update state for the network offering + false + string + + + tags + the tags for the network offering. + false + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + changeOutOfBandManagementPassword + Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + password + the new host management interface password of maximum length 16, if none is provided a random password would be used + false + string + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listResourceDetails + List resource detail(s) + false + 4.2 + + + resourcetype + list by resource type + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + if set to true, only details marked with display=true, are returned. False by default + false + 4.3 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + key + list by key + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + list by resource id + false + string + + + value + list by key, value. Needs to be passed only along with key + false + 4.4 + string + + + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + false + + + dedicateCluster + Dedicate an existing cluster + true + + + clusterid + the ID of the Cluster + true + uuid + + + domainid + the ID of the containing domain + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the cluster + string + + + affinitygroupid + the Dedication Affinity Group ID of the cluster + string + + + clusterid + the ID of the cluster + string + + + clustername + the name of the cluster + string + + + domainid + the domain ID of the cluster + string + + + false + + + createNetworkOffering + Creates a network offering. + false + 3.0.0 + + + guestiptype + guest type of the network offering: Shared or Isolated + true + string + + + name + the name of the network offering + true + string + + + traffictype + the traffic type for the network offering. Supported type in current release is GUEST only + true + string + + + availability + the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks + false + string + + + conservemode + true if the network offering is IP conserve mode enabled + false + boolean + + + details + Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup + false + map + 4.2.0 + map + + + displaytext + the display text of the network offering, defaults to the value of 'name'. + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + false + boolean + + + enable + set to true if the offering is to be enabled during creation. Default is false + false + 4.16 + boolean + + + fortungsten + true if network offering is meant to be used for Tungsten-Fabric, false otherwise. + false + boolean + + + forvpc + true if network offering is meant to be used for VPC, false otherwise. + false + boolean + + + internetprotocol + The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6 + false + 4.17.0 + string + + + ispersistent + true if network offering supports persistent networks; defaulted to false if not specified + false + boolean + + + keepaliveenabled + if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file. + false + boolean + + + maxconnections + maximum number of concurrent connections supported by the network offering + false + integer + + + networkrate + data transfer rate in megabits per second allowed + false + integer + + + servicecapabilitylist + desired service capabilities as part of network offering + false + map + map + + + serviceofferingid + the service offering ID used by virtual router provider + false + uuid + + + serviceproviderlist + provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network + false + map + map + + + specifyipranges + true if network offering supports specifying ip ranges; defaulted to false if not specified + false + boolean + + + specifyvlan + true if network offering supports vlans + false + boolean + + + supportedservices + services supported by the network offering + false + list + list + + + tags + the tags for the network offering. + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + createIpForwardingRule + Creates an IP forwarding rule + true + + + ipaddressid + the public IP address ID of the forwarding rule, already associated via associateIp + true + uuid + + + protocol + the protocol for the rule. Valid values are TCP or UDP. + true + string + + + startport + the start port for the rule + true + integer + + + cidrlist + the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use. + false + list + list + + + endport + the end port for the rule + false + integer + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default + false + boolean + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listElastistorInterface + Lists the network Interfaces of elastistor + false + + + controllerid + controller id + false + string + + + + + id + the id of the volume + string + + + compression + compression + string + + + deduplication + deduplication + string + + + graceallowed + graceallowed + string + + + name + the name of the volume + string + + + sync + synchronization + string + + + false + + + quotaStatement + Create a quota statement + false + 4.7.0 + + + account + Optional, Account Id for which statement needs to be generated + true + string + + + domainid + Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain. + true + uuid + + + enddate + End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + true + date + + + startdate + Start date range quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + true + date + + + accountid + List usage records for the specified account + false + uuid + + + type + List quota usage records for the specified usage type + false + integer + + + + + account + account name + string + + + accountid + account id + long + + + domain + domain id + long + + + name + usage type name + string + + + quota + quota consumed + bigdecimal + + + type + usage type + int + + + unit + usage unit + string + + + false + + + updateLBStickinessPolicy + Updates load balancer stickiness policy + true + 4.4 + + + id + id of lb stickiness policy + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + listPods + Lists all Pods. + false + + + allocationstate + list pods by allocation state + false + string + + + id + list Pods by ID + false + uuid + + + keyword + List by keyword + false + string + + + name + list Pods by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the pods + false + boolean + + + zoneid + list Pods by Zone ID + false + uuid + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + deleteTungstenFabricAddressGroup + delete Tungsten-Fabric address group + true + + + addressgroupuuid + the uuid of Tungsten-Fabric address group + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaTariffList + Lists all quota tariff plans + false + 4.7.0 + + + enddate + The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2021-11-03. + false + 4.18.0.0 + date + + + keyword + List by keyword + false + string + + + listall + False will list only not removed quota tariffs. If set to True, we will list all, including the removed ones. The default is false. + false + 4.18.0.0 + boolean + + + name + The name of the quota tariff. + false + 4.18.0.0 + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + The start date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + usagetype + Usage type of the resource + false + integer + + + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + uuid + uuid + string + + + false + + + stopKubernetesCluster + Stops a running CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addAccountToProject + Adds account to a project + true + 3.0.0 + + + projectid + ID of the project to add the account to + true + uuid + + + account + name of the account to be added to the project + false + string + + + email + email to which invitation to the project is going to be sent + false + string + + + projectroleid + ID of the project role + false + uuid + + + roletype + Project role type to be assigned to the user - Admin/Regular; default: Regular + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSnapshots + Lists all available snapshots for the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + lists snapshot by snapshot ID + false + uuid + + + ids + the IDs of the snapshots, mutually exclusive with id + false + list + 4.9 + list + + + imagestoreid + ID of the image or image cache store + false + 4.19 + uuid + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY. + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + locationtype + list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty + false + 4.19.0 + string + + + name + lists snapshot by snapshot name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showunique + If set to false, list templates across zones and their storages + false + 4.19.0 + boolean + + + snapshottype + valid values are MANUAL or RECURRING. + false + string + + + storageid + ID of the storage pool + false + 4.19 + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + volumeid + the ID of the disk volume + false + uuid + + + zoneid + list snapshots by zone id + false + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + migrateResourceToAnotherSecondaryStorage + migrates resources from one secondary storage to destination image store + true + 4.19.0 + + + destpool + id of the destination secondary storage pool to which the resources are to be migrated + true + uuid + + + srcpool + id of the image store from where the data is to be migrated + true + uuid + + + snapshots + id(s) of the snapshots to be migrated + false + list + list + + + templates + id(s) of the templates to be migrated + false + list + list + + + + + message + Response message from migration of secondary storage data objects + string + + + migrationtype + Type of migration requested for + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSSHKeyPair + Deletes a keypair by name + false + + + name + Name of the keypair + true + string + + + account + the account associated with the keypair. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the keypair + false + uuid + + + projectid + the project associated with keypair + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + searchLdap + Searches LDAP based on the username attribute + false + 4.2.0 + + + query + query to search using + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + readyForShutdown + Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown + false + 4.19.0 + + + managementserverid + the uuid of the management server + false + uuid + + + + + managementserverid + The id of the management server + long + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + createTungstenFabricLogicalRouter + create Tungsten-Fabric logical router + true + + + name + Tungsten-Fabric logical router name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createTungstenFabricFirewallRule + create Tungsten-Fabric firewall + true + + + action + Tungsten-Fabric firewall rule action + true + string + + + direction + Tungsten-Fabric firewall rule direction + true + string + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + true + string + + + name + Tungsten-Fabric firewall rule name + true + string + + + sequence + the sequence of Tungsten-Fabric firewall rule + true + integer + + + servicegroupuuid + Tungsten-Fabric firewall rule service group uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + destaddressgroupuuid + Tungsten-Fabric firewall rule destination address group uuid + false + string + + + destnetworkuuid + the uuid of Tungsten-Fabric destination network + false + string + + + desttaguuid + Tungsten-Fabric firewall rule destination tag uuid + false + string + + + srcaddressgroupuuid + Tungsten-Fabric firewall rule source address group uuid + false + string + + + srcnetworkuuid + the uuid of Tungsten-Fabric source network + false + string + + + srctaguuid + Tungsten-Fabric firewall rule source tag uuid + false + string + + + tagtypeuuid + Tungsten-Fabric firewall rule tag type uuid + false + string + + + + + action + Tungsten-Fabric firewall rule action + string + + + destaddressgroup + Tungsten-Fabric firewall rule destination address group + string + + + destnetwork + Tungsten-Fabric firewall rule destination network + string + + + desttag + Tungsten-Fabric firewall rule destination tag + string + + + direction + Tungsten-Fabric firewall rule direction + string + + + name + Tungsten-Fabric firewall rule name + string + + + servicegroup + Tungsten-Fabric firewall rule service group + string + + + srcaddressgroup + Tungsten-Fabric firewall rule source address group + string + + + srcnetwork + Tungsten-Fabric firewall rule source network + string + + + srctag + Tungsten-Fabric firewall rule source tag + string + + + tagtype + Tungsten-Fabric firewall rule tag type + string + + + uuid + Tungsten-Fabric firewall rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listConfigurations + Lists all configurations. + false + + + accountid + the ID of the Account to update the parameter value for corresponding account + false + uuid + + + category + lists configurations by category + false + string + + + clusterid + the ID of the Cluster to update the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to update the parameter value for corresponding domain + false + uuid + + + group + lists configuration by group name (primarily used for UI) + false + 4.18.0 + string + + + imagestoreuuid + the ID of the Image Store to update the parameter value for corresponding image store + false + uuid + + + keyword + List by keyword + false + string + + + name + lists configuration by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parent + lists configuration by parent name (primarily used for UI) + false + 4.18.0 + string + + + storageid + the ID of the Storage pool to update the parameter value for corresponding storage pool + false + uuid + + + subgroup + lists configuration by subgroup name (primarily used for UI) + false + 4.18.0 + string + + + zoneid + the ID of the Zone to update the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + scaleKubernetesCluster + Scales a created, running or stopped CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + false + boolean + + + maxsize + Maximum number of worker nodes in the cluster + false + long + + + minsize + Minimum number of worker nodes in the cluster + false + long + + + nodeids + the IDs of the nodes to be removed + false + list + list + + + serviceofferingid + the ID of the service offering for the virtual machines in the cluster. + false + uuid + + + size + number of Kubernetes cluster nodes + false + long + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + stopNetScalerVpx + Stops a NetScalervm. + true + + + id + the ID of the NetScaler vm + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + deleteInstanceGroup + Deletes a vm group + false + + + id + the ID of the instance group + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateTrafficType + Updates traffic type of a physical network + true + 3.0.0 + + + id + traffic type id + true + uuid + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a Hyperv host + false + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + false + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + false + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + false + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + false + string + + + + + id + id of the network provider + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a HyperV host + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + string + + + physicalnetworkid + the physical network this belongs to + string + + + traffictype + the trafficType to be added to the physical network + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + string + + + false + + + listConditions + List Conditions for VM auto scaling + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + counterid + Counter-id of the condition. + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + ID of the Condition. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + policyid + the ID of the policy + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the id of the Condition + string + + + account + the owner of the Condition. + string + + + counter + Details of the Counter. + counterresponse + + + counterid + the Id of the Counter. + string + + + countername + the Name of the Counter. + string + + + domain + the domain name of the owner. + string + + + domainid + the domain id of the Condition owner + string + + + domainpath + path of the domain to which the Condition owner belongs + 4.19.2.0 + string + + + project + the project name of the Condition + string + + + projectid + the project id of the Condition. + string + + + relationaloperator + Relational Operator to be used with threshold. + string + + + threshold + Threshold Value for the counter. + long + + + zoneid + zone id of counter + string + + + false + + + migrateSecondaryStorageData + migrates data objects from one secondary storage to destination image store(s) + true + 4.15.0 + + + destpools + id(s) of the destination secondary storage pool(s) to which the templates are to be migrated + true + list + list + + + srcpool + id of the image store from where the data is to be migrated + true + uuid + + + migrationtype + Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete + false + string + + + + + message + Response message from migration of secondary storage data objects + string + + + migrationtype + Type of migration requested for + string + + + success + true if operation is executed successfully + boolean + + + false + + + destroyVolume + Destroys a Volume. + true + 4.14.0 + + + id + The ID of the volume + true + uuid + + + expunge + If true is passed, the volume is expunged immediately. False by default. + false + 4.6.0 + boolean + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addTrafficType + Adds traffic type to a physical network + true + 3.0.0 + + + physicalnetworkid + the Physical Network ID + true + uuid + + + traffictype + the trafficType to be added to the physical network + true + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a Hyperv host + false + string + + + isolationmethod + Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'. + false + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + false + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + false + string + + + vlan + The VLAN id to be used for Management traffic by VMware host + false + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + false + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + false + string + + + + + id + id of the network provider + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a HyperV host + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + string + + + physicalnetworkid + the physical network this belongs to + string + + + traffictype + the trafficType to be added to the physical network + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + string + + + false + + + listSecondaryStorageSelectors + Lists the secondary storage selectors and their rules. + false + 4.19.0 + + + zoneid + The zone ID to be used in the search filter. + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + showremoved + Show removed heuristics. + false + boolean + + + type + Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + false + string + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + listLoadBalancerRuleInstances + List all virtual machine instances that are assigned to a load balancer rule. + false + + + id + the ID of the load balancer rule + true + uuid + + + applied + true if listing all virtual machines currently applied to the load balancer rule; default is true + false + boolean + + + keyword + List by keyword + false + string + + + lbvmips + true if load balancer rule VM IP information to be included; default is false + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + + + lbvmipaddresses + IP addresses of the vm set of lb rule + list + + + loadbalancerruleinstance + the user vm set for lb rule + uservmresponse + + + false + + + deleteCondition + Removes a condition for VM auto scaling + true + + + id + the ID of the condition. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updatePhysicalNetwork + Updates a physical network + true + 3.0.0 + + + id + physical network id + true + uuid + + + networkspeed + the speed for the physical network[1G/10G] + false + string + + + state + Enabled/Disabled + false + string + + + tags + Tag the physical network + false + list + list + + + vlan + the VLAN for the physical network + false + string + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + createTungstenFabricManagementNetwork + create Tungsten-Fabric management network + false + + + podid + the ID of pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricFirewallRule + list Tungsten-Fabric firewall rule + false + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + false + string + + + firewallruleuuid + the uuid of Tungsten-Fabric firewall rule + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + action + Tungsten-Fabric firewall rule action + string + + + destaddressgroup + Tungsten-Fabric firewall rule destination address group + string + + + destnetwork + Tungsten-Fabric firewall rule destination network + string + + + desttag + Tungsten-Fabric firewall rule destination tag + string + + + direction + Tungsten-Fabric firewall rule direction + string + + + name + Tungsten-Fabric firewall rule name + string + + + servicegroup + Tungsten-Fabric firewall rule service group + string + + + srcaddressgroup + Tungsten-Fabric firewall rule source address group + string + + + srcnetwork + Tungsten-Fabric firewall rule source network + string + + + srctag + Tungsten-Fabric firewall rule source tag + string + + + tagtype + Tungsten-Fabric firewall rule tag type + string + + + uuid + Tungsten-Fabric firewall rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createProject + Creates a project + true + 3.0.0 + + + name + name of the project + true + string + + + account + account who will be Admin for the project + false + string + + + accountid + ID of the account owning a project + false + uuid + + + displaytext + The display text of the project, defaults to the 'name´. + false + string + + + domainid + domain ID of the account owning a project + false + uuid + + + userid + user ID of the account to be assigned as owner of the project i.e., Project Admin + false + 4.15.0 + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + assignCertToLoadBalancer + Assigns a certificate to a load balancer rule + true + + + certid + the ID of the certificate + true + uuid + + + lbruleid + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addCiscoVnmcResource + Adds a Cisco Vnmc Controller + false + + + hostname + Hostname or ip address of the Cisco VNMC Controller. + true + string + + + password + Credentials to access the Cisco VNMC Controller API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Credentials to access the Cisco VNMC Controller API + true + string + + + + false + + + markDefaultZoneForAccount + Marks a default zone for this account + true + 4.0 + + + account + Name of the account that is to be marked. + true + string + + + domainid + Marks the account that belongs to the specified domain. + true + uuid + + + zoneid + The Zone ID with which the account is to be marked. + true + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + revokeCertificate + Revokes certificate using configured CA plugin + true + 4.11.0 + + + serial + The certificate serial number, as a hex value + true + string + + + cn + The certificate CN + false + string + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + changeServiceForSystemVm + Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect. + false + + + id + The ID of the system vm + true + uuid + + + serviceofferingid + the service offering ID to apply to the system vm + true + uuid + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + updateSiocInfo + Update SIOC info + false + 4.11.0 + + + iopsnotifythreshold + Notify if IOPS above this value + true + integer + + + limitiopspergb + Limit IOPS per GB + true + integer + + + sharespergb + Shares per GB + true + integer + + + storageid + Storage Pool ID + true + uuid + + + zoneid + Zone ID + true + uuid + + + + + msg + The return message from the operation ('Success' if successful) + string + + + false + + + cloudianSsoLogin + Generates single-sign-on login url for logged-in CloudStack user to access the Cloudian Management Console + false + 4.11.0 + + + + url + the sso redirect url + string + + + false + + + deleteVMSnapshot + Deletes a vmsnapshot. + true + 4.2.0 + + + vmsnapshotid + The ID of the VM snapshot + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + unmanageVirtualMachine + Unmanage a guest virtual machine. + true + 4.15.0 + + + id + The ID of the virtual machine to unmanage + true + uuid + + + + + details + details of the unmanage VM operation + string + + + success + result of the unmanage VM operation + boolean + + + false + + + rebootRouter + Starts a router. + true + + + id + the ID of the router + true + uuid + + + forced + Force reboot the router (Router is force Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listNics + list the vm nics IP to NIC + false + + + virtualmachineid + the ID of the vm + true + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + keyword + List by keyword + false + string + + + networkid + list nic of the specific vm's network + false + uuid + + + nicid + the ID of the nic to list IPs + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + false + + + createSnapshotFromVMSnapshot + Creates an instant snapshot of a volume from existing vm snapshot. + true + 4.10.0 + + + vmsnapshotid + The ID of the VM snapshot + true + uuid + + + volumeid + The ID of the disk volume + true + uuid + + + name + the name of the snapshot + false + string + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listImageStoreObjects + Lists objects at specified path on an image store. + false + 4.19.0 + + + id + id of the image store + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + path to list on image store + false + string + + + + + format + Format of template associated with the data store object. + string + + + isdirectory + Is it a directory. + boolean + + + lastupdated + Last modified date of the file/directory. + date + + + name + Name of the data store object. + string + + + size + Size is in Bytes. + long + + + snapshotid + Snapshot ID associated with the data store object. + string + + + templateid + Template ID associated with the data store object. + string + + + volumeid + Volume ID associated with the data store object. + string + + + false + + + dedicateGuestVlanRange + Dedicates a guest vlan range to an account + false + + + physicalnetworkid + physical network ID of the vlan + true + uuid + + + vlanrange + guest vlan range to be dedicated + true + string + + + account + account who will own the VLAN + false + string + + + domainid + domain ID of the account owning a VLAN + false + uuid + + + projectid + project who will own the VLAN + false + uuid + + + + + id + the ID of the guest VLAN range + string + + + account + the account of the guest VLAN range + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + domainpath + path of the domain to which the guest VLAN range belongs + 4.19.2.0 + string + + + guestvlanrange + the guest VLAN range + string + + + physicalnetworkid + the physical network of the guest vlan range + long + + + project + the project name of the guest vlan range + string + + + projectid + the project id of the guest vlan range + string + + + zoneid + the zone of the guest vlan range + long + + + false + + + updateIso + Updates an ISO file. + false + + + id + the ID of the image file + true + uuid + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteCounter + Deletes a counter for VM auto scaling + true + + + id + the ID of the counter + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + issueCertificate + Issues a client certificate using configured or provided CA plugin + true + 4.11.0 + + + csr + The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered + false + string + + + domain + Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN + false + string + + + duration + Certificate validity duration in number of days, when not provided the default configured value will be used + false + integer + + + ipaddress + Comma separated list of IP addresses, the certificate should be issued for + false + string + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + cacertificates + The CA certificate(s) + string + + + certificate + The client certificate + string + + + privatekey + Private key for the certificate + string + + + false + + + createPortForwardingRule + Creates a port forwarding rule + true + + + ipaddressid + the IP address id of the port forwarding rule + true + uuid + + + privateport + the starting port of port forwarding rule's private port range + true + integer + + + protocol + the protocol for the port forwarding rule. Valid values are TCP or UDP. + true + string + + + publicport + the starting port of port forwarding rule's public port range + true + integer + + + virtualmachineid + the ID of the virtual machine for the port forwarding rule + true + uuid + + + cidrlist + the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed. + false + list + list + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + networkid + the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case). + false + uuid + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true + false + boolean + + + privateendport + the ending port of port forwarding rule's private port range + false + integer + + + publicendport + the ending port of port forwarding rule's private port range + false + integer + + + vmguestip + VM guest nic secondary IP address for the port forwarding rule + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + dedicateZone + Dedicates a zones. + true + + + domainid + the ID of the containing domain + true + uuid + + + zoneid + the ID of the zone + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Zone is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the zone + string + + + domainid + the domain ID to which the Zone is dedicated + string + + + zoneid + the ID of the Zone + string + + + zonename + the Name of the Zone + string + + + false + + + prepareTemplate + load template into primary storage + false + + + templateid + template ID of the template to be prepared in primary storage(s). + true + uuid + + + zoneid + zone ID of the template to be prepared in primary storage(s). + true + uuid + + + storageid + storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateBackupOffering + Updates a backup offering. + false + 4.16.0 + + + id + The ID of the Backup Offering to be updated + true + uuid + + + allowuserdrivenbackups + Whether to allow user driven backups or not + false + boolean + + + description + The description of the Backup Offering to be updated + false + string + + + name + The name of the Backup Offering to be updated + false + string + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + listBuckets + Lists all Buckets. + false + 4.19.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the bucket + false + uuid + + + ids + the IDs of the Buckets, mutually exclusive with id + false + list + list + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the bucket + false + string + + + objectstorageid + the ID of the object storage pool, available to ROOT admin only + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + ID of the Bucket + string + + + accesskey + Bucket Access Key + string + + + account + the account associated with the Bucket + string + + + created + the date the Bucket was created + date + + + domain + the domain associated with the bucket + string + + + domainid + the ID of the domain associated with the bucket + string + + + domainpath + path of the domain to which the bucket belongs + 4.19.2.0 + string + + + encryption + Bucket Encryption + boolean + + + name + name of the Bucket + string + + + objectlocking + Bucket Object Locking + boolean + + + objectstorageid + id of the object storage hosting the Bucket; returned to admin user only + string + + + objectstore + Name of the object storage hosting the Bucket; returned to admin user only + string + + + policy + Bucket Access Policy + string + + + project + the project name of the bucket + string + + + projectid + the project id of the bucket + string + + + provider + Object storage provider + string + + + quota + Bucket Quota in GB + integer + + + size + Total size of objects in Bucket + long + + + state + State of the Bucket + string + + + url + Bucket URL + string + + + usersecretkey + Bucket Secret Key + string + + + versioning + Bucket Versioning + boolean + + + false + + + stopInternalLoadBalancerVM + Stops an Internal LB vm. + true + + + id + the ID of the internal lb vm + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateSecurityGroup + Updates a security group + false + 4.14.0.0 + + + id + The ID of the security group. + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + name + The new name of the security group. + false + string + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + samlSso + SP initiated SAML Single Sign On + false + + + idpid + Identity Provider Entity ID + true + string + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + createDomain + Creates a domain + false + + + name + creates domain with this name + true + string + + + domainid + Domain UUID, required for adding domain from another Region + false + string + + + networkdomain + Network domain for networks in the domain + false + string + + + parentdomainid + assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed. + false + uuid + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + addImageStore + Adds backup image store. + false + 4.2.0 + + + provider + the image store provider name + true + string + + + details + the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + name + the name for the image store + false + string + + + url + the URL for the image store + false + string + + + zoneid + the Zone ID for the image store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + revokeTemplateDirectDownloadCertificate + Revoke a direct download certificate from hosts in a zone + false + 4.13 + + + zoneid + (optional) zone to revoke certificate + true + uuid + + + hostid + (optional) the host ID to revoke certificate + false + uuid + + + hypervisor + (optional) hypervisor type + false + string + + + id + id of the certificate + false + uuid + + + name + (optional) alias of the SSL certificate + false + string + + + + + details + indicates the details in case of failure or host skipped + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + status + indicates if the certificate has been revoked from the host, failed or skipped + string + + + false + + + updateStorageCapabilities + Syncs capabilities of storage pools + false + 4.16.0 + + + id + Storage pool id + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + assignVolume + Changes ownership of a Volume from one account to another. + false + 4.18.0.0 + + + volumeid + The ID of the volume to be reassigned. + true + uuid + + + accountid + The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'. + false + uuid + + + projectid + The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'. + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteUserData + Deletes a userdata + false + 4.18 + + + id + the ID of the Userdata + true + uuid + + + account + an optional account for the userdata. Must be used with domainId. + false + string + + + domainid + an optional domainId for the userdata. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the userdata + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSupportedNetworkServices + Lists all network services provided by CloudStack or for the given Provider. + false + 3.0.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + network service provider name + false + string + + + service + network service name to list providers and capabilities of + false + string + + + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + false + + + revokeSecurityGroupIngress + Deletes a particular ingress rule from this security group + true + + + id + The ID of the ingress rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addNetworkServiceProvider + Adds a network serviceProvider to a physical network + true + 3.0.0 + + + name + the name for the physical network service provider + true + string + + + physicalnetworkid + the Physical Network ID to add the provider to + true + uuid + + + destinationphysicalnetworkid + the destination Physical Network ID to bridge to + false + uuid + + + servicelist + the list of services to be enabled for this physical network service provider + false + list + list + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + quotaTariffDelete + Marks a quota tariff as removed. + false + 4.18.0.0 + + + id + ID of the quota tariff + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVpnGateway + Delete site to site vpn gateway + true + + + id + id of customer gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createServiceOffering + Creates a service offering. + false + + + name + the name of the service offering + true + string + + + bytesreadrate + bytes read rate of the disk offering + false + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + long + + + byteswriterate + bytes write rate of the disk offering + false + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + long + + + cachemode + the cache mode to use for this disk offering. none, writeback or writethrough + false + 4.14 + string + + + cpunumber + the CPU number of the service offering + false + integer + + + cpuspeed + For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz. +For the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning. + false + integer + + + customized + Whether service offering size is custom or not + false + 4.13 + boolean + + + customizediops + whether compute offering iops is custom or not + false + 4.4 + boolean + + + deploymentplanner + The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used + false + string + + + diskofferingid + the ID of the disk offering to which service offering should be mapped + false + 4.17 + uuid + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + false + 4.17 + boolean + + + displaytext + The display text of the service offering, defaults to 'name'. + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + false + 4.16 + boolean + + + encryptroot + VMs using this offering require root volume encryption + false + 4.18 + boolean + + + hosttags + the host tag for this service offering. + false + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + false + 4.4 + integer + + + iopsreadrate + io requests read rate of the disk offering + false + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + long + + + iopswriterate + io requests write rate of the disk offering + false + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + long + + + issystem + is this a system vm offering + false + boolean + + + isvolatile + true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM + false + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + false + boolean + + + maxcpunumber + The maximum number of CPUs to be set with Custom Computer Offering + false + 4.13 + integer + + + maxiops + max iops of the compute offering + false + 4.4 + long + + + maxmemory + The maximum memory size of the custom service offering in MB + false + 4.13 + integer + + + memory + the total memory of the service offering in MB + false + integer + + + mincpunumber + The minimum number of CPUs to be set with Custom Computer Offering + false + 4.13 + integer + + + miniops + min iops of the compute offering + false + 4.4 + long + + + minmemory + The minimum memory size of the custom service offering in MB + false + 4.13 + integer + + + networkrate + data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtype + false + integer + + + offerha + the HA for the service offering + false + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + false + string + + + rootdisksize + the Root disk size in GB. + false + 4.15 + long + + + serviceofferingdetails + details for planner, used to store specific parameters + false + map + map + + + storagepolicy + Name of the storage policy defined at vCenter, this is applicable only for VMware + false + 4.15 + uuid + + + storagetype + the storage type of the service offering. Values are local and shared. + false + string + + + systemvmtype + the system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm". + false + string + + + tags + the tags for this service offering. + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + state + state of the service offering + string + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + assignVirtualMachine + Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain. + false + 3.0.0 + + + virtualmachineid + id of the VM to be moved + true + uuid + + + account + account name of the new VM owner. + false + string + + + domainid + domain id of the new VM owner. + false + uuid + + + networkids + list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created. + false + list + list + + + projectid + an optional project for the new VM owner. + false + uuid + + + securitygroupids + list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group. + false + list + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVmsForImport + Lists virtual machines on a unmanaged host + false + 4.19.0 + + + host + the host name or IP address + true + string + + + hypervisor + hypervisor type of the host + true + string + + + zoneid + the zone ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + password + the password for the host + false + string + + + username + the username for the host + false + string + + + + + clusterid + the ID of the cluster to which virtual machine belongs + string + + + clustername + the name of the cluster to which virtual machine belongs + string + + + cpucorepersocket + the CPU cores per socket for the virtual machine. VMware specific + integer + + + cpunumber + the CPU cores of the virtual machine + integer + + + cpuspeed + the CPU speed of the virtual machine + integer + + + hostid + the ID of the host to which virtual machine belongs + string + + + hostname + the name of the host to which virtual machine belongs + string + + + memory + the memory of the virtual machine in MB + integer + + + name + the name of the virtual machine + string + + + osdisplayname + the operating system of the virtual machine + string + + + osid + the operating system ID of the virtual machine + string + + + powerstate + the power state of the virtual machine + string + + + disk(*) + the list of disks associated with the virtual machine + + + id + the ID of the disk + string + + + capacity + the capacity of the disk in bytes + long + + + controller + the controller of the disk + string + + + controllerunit + the controller unit of the disk + integer + + + datastorehost + the controller of the disk + string + + + datastorename + the controller of the disk + string + + + datastorepath + the controller of the disk + string + + + datastoretype + the controller of the disk + string + + + imagepath + the file path of the disk image + string + + + label + the label of the disk + string + + + position + the position of the disk + integer + + + set + + + nic(*) + the list of nics associated with the virtual machine + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + configureNetscalerLoadBalancer + configures a netscaler load balancer device + true + + + lbdeviceid + Netscaler load balancer device ID + true + uuid + + + inline + true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall + false + boolean + + + lbdevicecapacity + capacity of the device, Capacity will be interpreted as number of networks device can handle + false + long + + + lbdevicededicated + true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts + false + boolean + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + false + list + list + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + deleteTungstenFabricServiceGroup + delete Tungsten-Fabric service group + true + + + servicegroupuuid + the uuid of Tungsten-Fabric service group + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addObjectStoragePool + Adds a object storage pool + false + 4.19.0 + + + name + the name for the object store + true + string + + + provider + the object store provider name + true + string + + + url + the URL for the object store + true + string + + + details + the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + tags + the tags for the storage pool + false + string + + + + + id + the ID of the object store + string + + + name + the name of the object store + string + + + providername + the provider name of the object store + string + + + storagetotal + the total size of the object store + long + + + storageused + the object store currently used size + long + + + url + the url of the object store + string + + + false + + + deleteUserFromProject + Deletes user from the project + true + 4.15.0 + + + projectid + ID of the project to remove the user from + true + uuid + + + userid + Id of the user to be removed from the project + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkServiceProvider + Deletes a Network Service Provider. + true + 3.0.0 + + + id + the ID of the network service provider + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkDevice + List network devices + false + + + keyword + List by keyword + false + string + + + networkdeviceparameterlist + parameters for network device + false + map + map + + + networkdevicetype + Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the network device + string + + + false + + + listProjectRoles + Lists Project roles in CloudStack + false + 4.15.0 + + + projectid + List project role by project ID. + true + uuid + + + keyword + List by keyword + false + string + + + name + List project role by project role name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectroleid + List project role by project role ID. + false + uuid + + + + + projectid + the id of the project + string + + + false + + + deleteOpenDaylightController + Removes an OpenDyalight controler + true + + + id + OpenDaylight Controller ID + true + uuid + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + updateTemplate + Updates attributes of a template. + false + + + id + the ID of the image file + true + uuid + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + string + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateVpnConnection + Updates site to site vpn connection + true + 4.4 + + + id + id of vpn connection + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + createVlanIpRange + Creates a VLAN IP range. + false + + + account + account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted + false + string + + + domainid + domain ID of the account owning a VLAN + false + uuid + + + endip + the ending IP address in the VLAN IP range + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + forsystemvms + true if IP range is set to system vms, false if not + false + boolean + + + forvirtualnetwork + true if VLAN is of Virtual type, false if Direct + false + boolean + + + gateway + the gateway of the VLAN IP range + false + string + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6gateway + the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC + false + string + + + netmask + the netmask of the VLAN IP range + false + string + + + networkid + the network id + false + uuid + + + physicalnetworkid + the physical network id + false + uuid + + + podid + optional parameter. Have to be specified for Direct Untagged vlan only. + false + uuid + + + projectid + project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted + false + uuid + + + startip + the beginning IP address in the VLAN IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + vlan + the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged + false + string + + + zoneid + the Zone ID of the VLAN IP range + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + listPaloAltoFirewallNetworks + lists network that are using Palo Alto firewall device + false + + + lbdeviceid + palo alto balancer device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getPathForVolume + Get the path associated with the provided volume UUID + false + + + volumeid + CloudStack Volume UUID + true + string + + + + + path + The path field for the volume + string + + + false + + + listTungstenFabricPolicyRule + list Tungsten-Fabric policy + false + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + ruleuuid + the uuid of Tungsten-Fabric rule + false + string + + + zoneid + the ID of zone + false + uuid + + + + + action + Tungsten-Fabric policy action + string + + + destendport + Tungsten-Fabric policy destination end port + int + + + destipprefix + Tungsten-Fabric policy destination ip prefix + string + + + destipprefixlen + Tungsten-Fabric policy destination ip prefix length + int + + + destnetwork + Tungsten-Fabric policy destination network + string + + + deststartport + Tungsten-Fabric policy destination start port + int + + + direction + Tungsten-Fabric policy name + string + + + policyuuid + Tungsten-Fabric policy uuid + string + + + protocol + Tungsten-Fabric policy protocol + string + + + srcendport + Tungsten-Fabric policy source end port + int + + + srcipprefix + Tungsten-Fabric policy source ip prefix + string + + + srcipprefixlen + Tungsten-Fabric policy source ip prefix length + int + + + srcnetwork + Tungsten-Fabric policy source network + string + + + srcstartport + Tungsten-Fabric policy source start port + int + + + uuid + Tungsten-Fabric rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listManagementServers + Lists management servers. + false + + + id + the id of the management server + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the management server + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the management server + string + + + javadistribution + the java distribution name running the management server process + string + + + javaversion + the version of the java distribution running the management server process + string + + + kernelversion + the running OS kernel version for this Management Server + string + + + lastboottime + the last time the host on which this Management Server runs was booted + date + + + lastserverstart + the last time this Management Server was started + date + + + lastserverstop + the last time this Management Server was stopped + date + + + name + the name of the management server + string + + + osdistribution + the name of the OS distribution running on the management server + string + + + serviceip + the IP Address for this Management Server + string + + + state + the state of the management server + state + + + version + the version of the management server + string + + + false + + + deleteTungstenFabricPolicy + delete Tungsten-Fabric policy + true + + + policyuuid + the Uuid of Tungsten-Fabric tag type + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateInstanceGroup + Updates a vm group + false + + + id + Instance group ID + true + uuid + + + name + new instance group name + false + string + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + domainpath + path of the Domain the instance group belongs to + 4.19.2.0 + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + listTemplateDirectDownloadCertificates + List the uploaded certificates for direct download templates + false + 4.17.0 + + + id + list direct download certificate by ID + false + uuid + + + keyword + List by keyword + false + string + + + listhosts + if set to true: include the hosts where the certificate is uploaded to + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the zone where certificates are uploaded + false + uuid + + + + + id + the direct download certificate id + string + + + alias + the direct download certificate alias + string + + + hostsmap + the hosts where the certificate is uploaded to + list + + + hypervisor + the hypervisor of the hosts where the certificate is uploaded + string + + + issuer + the direct download certificate issuer + string + + + serialnum + the direct download certificate serial num + string + + + subject + the direct download certificate subject + string + + + validity + the direct download certificate issuer + string + + + version + the direct download certificate version + string + + + zoneid + the zone id where the certificate is uploaded + string + + + zonename + the zone name where the certificate is uploaded + string + + + false + + + listUcsManagers + List ucs manager + false + + + id + the ID of the ucs manager + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the zone id + false + uuid + + + + + id + the ID of the ucs manager + string + + + name + the name of ucs manager + string + + + url + the url of ucs manager + string + + + zoneid + the zone ID of ucs manager + string + + + false + + + changeServiceForRouter + Upgrades domain router to a new service offering + false + + + id + The ID of the router + true + uuid + + + serviceofferingid + the service offering ID to apply to the domain router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateVolume + Updates the volume. + true + + + chaininfo + The chain info of the volume + false + 4.4 + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displayvolume + an optional field, whether to the display the volume to the end user or not. + false + boolean + + + id + the ID of the disk volume + false + uuid + + + name + new name of the volume + false + 4.16 + string + + + path + The path of the volume + false + string + + + state + The state of the volume + false + 4.3 + string + + + storageid + Destination storage pool UUID for the volume + false + 4.3 + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTrafficTypes + Lists traffic types of a given physical network. + false + 3.0.0 + + + physicalnetworkid + the Physical Network ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + updateVirtualMachine + Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call. + false + + + id + The ID of the virtual machine + true + uuid + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + details + Details in key/value pairs. 'extraconfig' is not allowed to be passed in details. + false + map + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + displayname + user generated name + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + group of the virtual machine + false + string + + + haenable + true if high-availability is enabled for the virtual machine, false otherwise + false + boolean + + + instancename + instance name of the user vm + false + 4.4 + string + + + isdynamicallyscalable + true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting + false + boolean + + + name + new host name of the vm. The VM has to be stopped/started for this update to take affect + false + 4.4 + string + + + ostypeid + the ID of the OS type that best represents this VM. + false + uuid + + + securitygroupids + list of security group ids to be applied on the virtual machine. + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + 4.16.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the userdata + false + 4.18 + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addSecondaryStorage + Adds secondary storage. + false + + + url + the URL for the secondary storage + true + string + + + zoneid + the Zone ID for the secondary storage + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + updateAccount + Updates account information for the authenticated user + false + + + account + Current account name + false + string + + + accountdetails + Details for the account used to store specific parameters + false + map + map + + + domainid + The UUID of the domain where the account exists + false + uuid + + + id + Account UUID + false + uuid + + + networkdomain + Network domain for the account's networks; empty string will update domainName with NULL value + false + string + + + newname + New name for the account + false + string + + + roleid + The UUID of the dynamic role to set for the account + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + listDomains + Lists domains and provides detailed information for listed domains + false + + + details + comma separated list of domain details requested, value can be a list of [ all, resource, min] + false + list + list + + + id + List domain by domain ID. + false + uuid + + + keyword + List by keyword + false + string + + + level + List domains by domain level. + false + integer + + + listall + 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 + false + boolean + + + name + List domain by domain name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for domains + false + boolean + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + disableAccount + Disables an account + true + + + lock + If true, only lock the account; else disable the account + true + boolean + + + account + Disables specified account. + false + string + + + domainid + Disables specified account in this domain. + false + uuid + + + id + Account id + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + resetUserDataForVirtualMachine + Resets the UserData for virtual machine. The virtual machine must be in a "Stopped" state. [async] + false + + + id + The ID of the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the virtual machine + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + map + + + userdataid + the ID of the userdata + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listNetworkACLLists + Lists all network ACLs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists network ACL with the specified ID. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list network ACLs by specified name + false + string + + + networkid + list network ACLs by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + list network ACLs by VPC ID + false + uuid + + + + + id + the ID of the ACL + string + + + description + Description of the ACL + string + + + fordisplay + is ACL for display to the regular user + 4.4 + boolean + + + name + the Name of the ACL + string + + + vpcid + Id of the VPC this ACL is associated with + string + + + vpcname + Name of the VPC this ACL is associated with + string + + + false + + + deleteTemplate + Deletes a template from the system. All virtual machines using the deleted template will not be affected. + true + + + id + the ID of the template + true + uuid + + + forced + Force delete a template. + false + 4.9+ + boolean + + + zoneid + the ID of zone of the template + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + archiveSnapshot + Archives (moves) a snapshot on primary storage to secondary storage + true + + + id + The ID of the snapshot + true + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateVpnGateway + Updates site to site vpn local gateway + true + 4.4 + + + id + id of customer gateway + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + releaseDedicatedGuestVlanRange + Releases a dedicated guest vlan range to the system + true + + + id + the ID of the dedicated guest vlan range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSecurityGroup + Deletes security group + false + + + account + the account of the security group. Must be specified with domain ID + false + string + + + domainid + the domain ID of account owning the security group + false + uuid + + + id + The ID of the security group. Mutually exclusive with name parameter + false + uuid + + + name + The ID of the security group. Mutually exclusive with id parameter + false + string + + + projectid + the project of the security group + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + importVolume + Import an unmanaged volume from a storage pool on a host into CloudStack + true + 4.19.1 + + + path + the path of the volume + true + string + + + storageid + the ID of the storage pool + true + uuid + + + account + an optional account for the volume. Must be used with domainId. + false + string + + + diskofferingid + the ID of the disk offering linked to the volume + false + uuid + + + domainid + import volume to the domain specified + false + uuid + + + name + the name of the volume. If not set, it will be set to the path of the volume. + false + string + + + projectid + import volume for the project + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTemplate + Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it. + true + + + name + the name of the template + true + string + + + ostypeid + the ID of the OS Type that best represents the OS of this template. + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + 4.19.0 + string + + + bits + 32 or 64 bit + false + integer + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + The display text of the template, defaults to the 'name'. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + 4.19.0 + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if this template is a public template, false otherwise + false + boolean + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + create template for the project + false + uuid + + + requireshvm + true if the template requires HVM, false otherwise + false + boolean + + + snapshotid + the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in + false + uuid + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + url + Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server + false + string + + + virtualmachineid + Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal + false + uuid + + + volumeid + the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in + false + uuid + + + zoneid + the zone for the template. Can be specified with snapshot only + false + 4.19.0 + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + restoreBackup + Restores an existing stopped or deleted VM using a VM backup + true + 4.14.0 + + + id + ID of the backup + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listDedicatedClusters + Lists dedicated clusters. + false + + + account + the name of the account associated with the cluster. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated clusters by affinity group + false + uuid + + + clusterid + the ID of the cluster + false + uuid + + + domainid + the ID of the domain associated with the cluster + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the cluster + string + + + affinitygroupid + the Dedication Affinity Group ID of the cluster + string + + + clusterid + the ID of the cluster + string + + + clustername + the name of the cluster + string + + + domainid + the domain ID of the cluster + string + + + false + + + uploadCustomCertificate + Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself. + true + + + certificate + The certificate to be uploaded. + true + string + + + domainsuffix + DNS domain suffix that the certificate is granted for. + true + string + + + id + An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3 + false + integer + + + name + A name / alias for the certificate. + false + string + + + privatekey + The private key for the attached certificate. + false + string + + + + + message + message of the certificate upload operation + string + + + false + + + quotaUpdate + Update quota calculations, alerts and statements + false + 4.7.0 + + + + updated_on + timestamp when the run got over + date + + + false + + + listTungstenFabricNetwork + list Tungsten-Fabric network + false + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false + false + boolean + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric network name + string + + + uuid + Tungsten-Fabric network uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listTrafficMonitors + List traffic monitor Hosts. + false + + + zoneid + zone Id + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the external firewall + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + updatePortForwardingRule + Updates a port forwarding rule. Only the private port and the virtual machine can be updated. + true + + + id + the ID of the port forwarding rule + true + 4.4 + uuid + + + cidrlist + the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed. + false + list + list + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + privateendport + the private end port of the port forwarding rule + false + integer + + + privateport + the private start port of the port forwarding rule + false + integer + + + virtualmachineid + the ID of the virtual machine for the port forwarding rule + false + uuid + + + vmguestip + VM guest nic Secondary ip address for the port forwarding rule + false + 4.5 + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + associateIpAddress + Acquires and associates a public IP to an account. + true + + + account + the account to associate with this IP address + false + string + + + domainid + the ID of the domain to associate with this IP address + false + uuid + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + 4.4 + boolean + + + ipaddress + IP Address to be associated + false + string + + + isportable + should be set to true if public IP is required to be transferable across zones, if not specified defaults to false + false + boolean + + + networkid + The network this IP address should be associated to. + false + uuid + + + projectid + Deploy VM for the project + false + uuid + + + regionid + region ID from where portable IP is to be associated. + false + integer + + + vpcid + the VPC you want the IP address to be associated with + false + uuid + + + zoneid + the ID of the availability zone you want to acquire an public IP address from + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + getSolidFireVolumeAccessGroupIds + Get the SF Volume Access Group IDs + false + + + clusterid + Cluster UUID + true + string + + + storageid + Storage Pool UUID + true + string + + + + + solidFireVolumeAccessGroupIds + SolidFire Volume Access Group Ids + long[] + + + false + + + deleteVpnConnection + Delete site to site vpn connection + true + + + id + id of vpn connection + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAlertTypes + Lists all alerts types + false + + + + id + the id of the alert + string + + + description + description of the alert + string + + + name + the name of the alert + 4.3 + string + + + sent + the date and time the alert was sent + date + + + type + One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29 + short + + + false + + + resetSSHKeyForVirtualMachine + Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async] + true + + + id + The ID of the virtual machine + true + uuid + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs to be used to login to the virtual machine + false + list + 4.17 + list + + + projectid + an optional project for the ssh key + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createNetworkACL + Creates a ACL rule in the given network (the network has to belong to VPC) + true + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + true + string + + + aclid + The network of the VM the ACL will be created for + false + uuid + + + action + scl entry action, allow or deny + false + string + + + cidrlist + the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of ACL + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + networkid + The network of the VM the ACL will be created for + false + uuid + + + number + The number of the ACL item, its ordering + false + integer + + + reason + A description indicating why the ACL rule is required. + false + string + + + startport + the starting port of ACL + false + integer + + + traffictype + the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteManagementNetworkIpRange + Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated. + true + 4.11.0.0 + + + endip + The ending IP address. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + startip + The starting IP address. + true + string + + + vlan + The vlan id the ip range sits on + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addKubernetesSupportedVersion + Add a supported Kubernetes version + false + + + mincpunumber + the minimum number of CPUs to be set with the Kubernetes version + true + integer + + + minmemory + the minimum RAM size in MB to be set with the Kubernetes version + true + integer + + + semanticversion + the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format + true + string + + + checksum + the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + directdownload + If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false + false + 4.18.2 + boolean + + + name + the name of the Kubernetes supported version + false + string + + + url + the URL of the binaries ISO for Kubernetes supported version + false + string + + + zoneid + the ID of the zone in which Kubernetes supported version will be available + false + uuid + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + directdownload + KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage + 4.18.2 + boolean + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + linkUserDataToTemplate + Link or unlink a userdata to a template. + false + 4.18.0 + + + isoid + the ID of the ISO for the virtual machine + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + userdataid + the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO + false + uuid + + + userdatapolicy + an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride + false + string + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listGlobalLoadBalancerRules + Lists load balancer rules. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the global load balancer rule + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + regionid + region ID + false + integer + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + getKubernetesClusterConfig + Get Kubernetes cluster config + false + + + id + the ID of the Kubernetes cluster + false + uuid + + + + + id + the id of the container cluster + string + + + configdata + the config data of the cluster + string + + + name + Name of the container cluster + string + + + false + + + releaseDedicatedCluster + Release the dedication for cluster + true + + + clusterid + the ID of the Cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteDiskOffering + Updates a disk offering. + false + + + id + ID of the disk offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteAutoScalePolicy + Deletes a autoscale policy. + true + + + id + the ID of the autoscale policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteCiscoNexusVSM + delete a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteRole + Deletes a role + false + 4.9.0 + + + id + ID of the role + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listInternalLoadBalancerVMs + List internal LB VMs. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fetchhealthcheckresults + if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false + false + 4.14 + boolean + + + forvpc + if true is passed for this parameter, list only VPC Internal LB VMs + false + boolean + + + hostid + the host ID of the Internal LB VM + false + uuid + + + id + the ID of the Internal LB VM + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the Internal LB VM + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the Internal LB VM + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + the state of the Internal LB VM + false + string + + + vpcid + List Internal LB VMs by VPC + false + uuid + + + zoneid + the Zone ID of the Internal LB VM + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listCiscoVnmcResources + Lists Cisco VNMC controllers + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + resourceid + Cisco VNMC resource ID + false + uuid + + + + false + + + executeClusterDrsPlan + Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail. + true + 4.19.0 + + + id + ID of cluster + true + uuid + + + migrateto + Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=<uuid>&migrateto[vm-index].host=<uuid> Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm=<uuid> indicates the UUID of the vm that you want to migrate, and host=<uuid> indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc> + false + map + map + + + + + id + unique ID of the drs plan for cluster + string + + + clusterid + Id of the cluster + string + + + eventid + Start event Id of the DRS Plan + string + + + migrations + List of migrations + list + + + status + Status of DRS Plan + status + + + type + Type of DRS Plan (Automated or Manual)) + type + + + false + + + revokeSecurityGroupEgress + Deletes a particular egress rule from this security group + true + 3.0.0 + + + id + The ID of the egress rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + uploadResourceIcon + Uploads an icon for the specified resource(s) + false + 4.16.0.0 + + + base64image + Base64 string representation of the resource icon/image + true + string + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateKubernetesSupportedVersion + Update a supported Kubernetes version + false + + + id + the ID of the Kubernetes supported version + true + uuid + + + state + the enabled or disabled state of the Kubernetes supported version + true + string + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + directdownload + KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage + 4.18.2 + boolean + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + createGuestNetworkIpv6Prefix + Creates a guest network IPv6 prefix. + true + 4.17.0.0 + + + prefix + The /56 or higher IPv6 CIDR for network prefix. + true + string + + + zoneid + UUID of zone to which the IPv6 prefix belongs to. + true + uuid + + + + + id + id of the guest IPv6 prefix + string + + + availablesubnets + count of the available IPv6 subnets for the prefix. + integer + + + created + date when this IPv6 prefix was created. + date + + + prefix + guest IPv6 prefix + string + + + totalsubnets + count of the total IPv6 subnets for the prefix. + integer + + + usedsubnets + count of the used IPv6 subnets for the prefix. + integer + + + zoneid + id of zone to which the IPv6 prefix belongs to. + string + + + false + + + createRole + Creates a role + false + 4.9.0 + + + name + Creates a role with this unique name + true + string + + + description + The description of the role + false + string + + + ispublic + Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true. + false + boolean + + + roleid + ID of the role to be cloned from. Either roleid or type must be passed in + false + uuid + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + getUploadParamsForVolume + Upload a data disk to the cloudstack cloud. + false + 4.6.0 + + + format + the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume/template/iso + true + string + + + zoneid + the ID of the zone the volume/template/iso is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + checksum + the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + diskofferingid + the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown. + false + uuid + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + imagestoreuuid + Image store uuid + false + string + + + projectid + Upload volume/template/iso for the project + false + uuid + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + updateAutoScaleVmProfile + Updates an existing autoscale vm profile. + true + + + id + the ID of the autoscale vm profile + true + uuid + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + false + uuid + + + counterparam + counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161 + false + map + map + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + false + integer + + + fordisplay + an optional field, whether to the display the profile to the end user or not + false + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. +Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 . +Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". + false + map + 4.18.0 + map + + + serviceofferingid + the service offering of the auto deployed virtual machine + false + 4.18.0 + uuid + + + templateid + the template of the auto deployed virtual machine + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + 4.18.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18.1 + map + + + userdataid + the ID of the userdata + false + 4.18.1 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + domainpath + path of the domain to which the vm profile belongs + 4.19.2.0 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base64 encoded VM user data + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.1 + string + + + userdataid + the id of userdata used for the VM + 4.18.1 + string + + + userdataname + the name of userdata used for the VM + 4.18.1 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.1 + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + enableAutoScaleVmGroup + Enables an AutoScale Vm Group + true + + + id + the ID of the autoscale group + true + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + listGuestNetworkIpv6Prefixes + Lists guest network IPv6 prefixes + false + 4.17.0 + + + id + UUID of the IPv6 prefix. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + UUID of zone to which the IPv6 prefix belongs to. + false + uuid + + + + + id + id of the guest IPv6 prefix + string + + + availablesubnets + count of the available IPv6 subnets for the prefix. + integer + + + created + date when this IPv6 prefix was created. + date + + + prefix + guest IPv6 prefix + string + + + totalsubnets + count of the total IPv6 subnets for the prefix. + integer + + + usedsubnets + count of the used IPv6 subnets for the prefix. + integer + + + zoneid + id of zone to which the IPv6 prefix belongs to. + string + + + false + + + updateGuestOsMapping + Updates the information about Guest OS to Hypervisor specific name mapping + true + 4.4.0 + + + id + UUID of the Guest OS to hypervisor name Mapping + true + uuid + + + osnameforhypervisor + Hypervisor specific name for this Guest OS + true + string + + + osmappingcheckenabled + When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.) + false + 4.19.0 + boolean + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + deleteTungstenFabricTag + delete Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateHostPassword + Update password of a host/pool on management server. + false + + + password + the new password for the host/cluster + true + string + + + username + the username for the host/cluster + true + string + + + clusterid + the cluster ID + false + uuid + + + hostid + the host ID + false + uuid + + + update_passwd_on_host + if the password should also be updated on the hosts + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createPortableIpRange + adds a range of portable public IP's to a region + true + 4.2.0 + + + endip + the ending IP address in the portable IP range + true + string + + + gateway + the gateway for the portable IP range + true + string + + + netmask + the netmask of the portable IP range + true + string + + + regionid + Id of the Region + true + integer + + + startip + the beginning IP address in the portable IP range + true + string + + + vlan + VLAN id, if not specified defaulted to untagged + false + string + + + + + id + portable IP range ID + string + + + endip + the end ip of the portable IP range + string + + + gateway + the gateway of the VLAN IP range + string + + + netmask + the netmask of the VLAN IP range + string + + + regionid + Region Id in which portable ip range is provisioned + integer + + + startip + the start ip of the portable IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + portableipaddress(*) + List of portable IP and association with zone/network/vpc details that are part of GSLB rule + + + accountid + the account ID the portable IP address is associated with + string + + + allocated + date the portal IP address was acquired + date + + + domainid + the domain ID the portable IP address is associated with + string + + + ipaddress + public IP address + string + + + networkid + the ID of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + regionid + Region Id in which global load balancer is created + integer + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing and Free + string + + + vpcid + VPC the ip belongs to + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + list + + + false + + + listVmwareDcVms + Lists the VMs in a Vmware Datacenter + false + + + batchsize + The maximum number of results to return. + false + integer + + + datacentername + Name of Vmware datacenter. + false + string + + + existingvcenterid + UUID of a linked existing vCenter + false + uuid + + + host + get only the VMs from the specified host. + false + string + + + password + The password for specified username. + false + string + + + token + For listVmwareDcVms, if the maximum number of results (the `batchsize`) is exceeded, a token is returned. This token can be used in subsequent calls to retrieve more results. As long as a token is returned, more results can be retrieved. + false + string + + + username + The Username required to connect to resource. + false + string + + + vcenter + The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + token + The Vmware API token to use for retrieving further responses with + string + + + false + + + updateCluster + Updates an existing cluster + false + + + id + the ID of the Cluster + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + clustername + the cluster name + false + string + + + clustertype + hypervisor type of the cluster + false + string + + + hypervisor + hypervisor type of the cluster + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + listStorageProviders + Lists storage providers. + false + + + type + the type of storage provider: either primary or image + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + the name of the storage provider + string + + + type + the type of the storage provider: primary or image provider + string + + + false + + + listUcsProfiles + List profile in ucs manager + false + + + ucsmanagerid + the id for the ucs manager + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + ucsdn + ucs profile dn + string + + + false + + + getUserKeys + This command allows the user to query the seceret and API keys for the account + false + 4.10.0 + + + id + ID of the user whose keys are required + true + uuid + + + + + apikey + the api key of the registered user + string + + + secretkey + the secret key of the registered user + string + + + false + + + updateGlobalLoadBalancerRule + update global load balancer rules. + true + + + id + the ID of the global load balancer rule + true + uuid + + + description + the description of the load balancer rule + false + string + + + gslblbmethod + load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin' + false + string + + + gslbstickysessionmethodname + session sticky method (sourceip) if not specified defaults to sourceip + false + string + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + authorizeSamlSso + Allow or disallow a user to use SAML SSO + false + + + enable + If true, authorizes user to be able to use SAML for Single Sign. If False, disable user to user SAML SSO. + true + boolean + + + userid + User uuid + true + uuid + + + entityid + The Identity Provider ID the user is allowed to get single signed on from + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addGuestOs + Add a new guest OS type + true + 4.4.0 + + + oscategoryid + ID of Guest OS category + true + uuid + + + osdisplayname + Unique display name for Guest OS + true + string + + + details + Map of (key/value pairs) + false + map + map + + + forDisplay + whether this guest OS is available for end users + false + boolean + + + name + Optional name for Guest OS + false + string + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + fordisplay + is the guest OS visible for the users + boolean + + + isuserdefined + is the guest OS user defined + boolean + + + name + the name of the OS type + string + + + oscategoryid + the ID of the OS category + string + + + oscategoryname + the name of the OS category + string + + + false + + + listHostTags + Lists host tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the host tag + string + + + hostid + the host ID of the host tag + long + + + name + the name of the host tag + string + + + false + + + addAnnotation + add an annotation. + false + 4.11 + + + adminsonly + the annotation is visible for admins only + false + 4.16.0 + boolean + + + annotation + the annotation text + false + string + + + entityid + the id of the entity to annotate + false + string + + + entitytype + The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER + false + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + listIdps + Returns list of discovered SAML Identity Providers + false + + + + id + The IdP Entity ID + string + + + orgName + The IdP Organization Name + string + + + orgUrl + The IdP Organization URL + string + + + false + + + deployNetscalerVpx + Creates new NS Vpx + true + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + networkid + The network this ip address should be associated to. + false + uuid + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + listElastistorVolume + Lists the volumes of elastistor + false + + + id + the ID of the account + true + string + + + + + id + the id of the volume + string + + + compression + compression + string + + + deduplication + deduplication + string + + + graceallowed + graceallowed + string + + + name + the name of the volume + string + + + sync + synchronization + string + + + false + + + listNiciraNvpDevices + Lists Nicira NVP devices + false + + + keyword + List by keyword + false + string + + + nvpdeviceid + nicira nvp device ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + hostname + the controller Ip address + string + + + l2gatewayserviceuuid + this L2 gateway service Uuid + string + + + l3gatewayserviceuuid + this L3 gateway service Uuid + string + + + niciradevicename + device name + string + + + nvpdeviceid + device id of the Nicire Nvp + string + + + physicalnetworkid + the physical network to which this Nirica Nvp belongs to + string + + + provider + name of the provider + string + + + transportzoneuuid + the transport zone Uuid + string + + + false + + + addBaremetalPxeKickStartServer + add a baremetal pxe server + true + + + password + Credentials to reach external pxe device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + pxeservertype + type of pxe device + true + string + + + tftpdir + Tftp root directory of PXE server + true + string + + + url + URL of the external pxe device + true + string + + + username + Credentials to reach external pxe device + true + string + + + podid + Pod Id + false + uuid + + + + + tftpdir + Tftp root directory of PXE server + string + + + false + + + listAlerts + Lists all alerts. + false + + + id + the ID of the alert + false + uuid + + + keyword + List by keyword + false + string + + + name + list by alert name + false + 4.3 + string + + + page + false + integer + + + pagesize + false + integer + + + type + list by alert type + false + string + + + + + id + the id of the alert + string + + + description + description of the alert + string + + + name + the name of the alert + 4.3 + string + + + sent + the date and time the alert was sent + date + + + type + One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29 + short + + + false + + + deployVirtualMachine + Creates and automatically starts a virtual machine based on a service offering, disk offering, and template. + true + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter + false + list + list + + + bootintosetup + Boot into hardware setup or not (ignored if startVm = false, only valid for vmware) + false + 4.15.0.0 + boolean + + + bootmode + Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + boottype + Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + clusterid + destination Cluster ID to deploy the VM to - parameter available for root admin only + false + 4.13 + uuid + + + copyimagetags + if true the image tags (if any) will be copied to the VM, default value is false + false + 4.13 + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter + false + map + 4.11 + map + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + details + used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details + false + map + 4.3 + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + diskofferingid + the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created. + false + uuid + + + displayname + an optional user generated name for the virtual machine + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + 4.2 + boolean + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain. + false + uuid + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable + false + 4.16 + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + an optional group for the virtual machine + false + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + uuid + + + hypervisor + the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call + false + string + + + iodriverpolicy + Controls specific policies on IO + false + string + + + iothreadsenabled + IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs. + false + boolean + + + ip6address + the ipv6 address for default vm's network + false + string + + + ipaddress + the ip address for default vm's network + false + string + + + iptonetworklist + ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid + false + map + map + + + keyboard + an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us + false + string + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs used to login to the virtual machine + false + list + 4.17 + list + + + macaddress + the mac address for default vm's network + false + string + + + name + host name for the virtual machine + false + string + + + networkids + list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter + false + list + list + + + nicmultiqueuenumber + The number of queues for multiqueue NICs. + false + 4.18 + integer + + + nicnetworklist + VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid + false + map + 4.15 + map + + + nicpackedvirtqueuesenabled + Enable packed virtqueues or not. + false + 4.18 + boolean + + + overridediskofferingid + the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id + false + 4.17 + uuid + + + password + The password of the virtual machine. If null, a random password will be generated for the VM. + false + 4.19.0.0 + string + + + podid + destination Pod ID to deploy the VM to - parameter available for root admin only + false + 4.13 + uuid + + + projectid + Deploy vm for the project + false + uuid + + + properties + used to specify the vApp properties. + false + map + 4.15 + map + + + rootdisksize + Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.4 + long + + + securitygroupids + comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + size + the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId + false + long + + + startvm + true if start vm after creating; defaulted to true if not specified + false + boolean + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the Userdata + false + 4.18 + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVolumes + Lists all volumes. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster id the disk volume belongs to + false + uuid + + + diskofferingid + list volumes by disk offering + false + 4.4 + uuid + + + displayvolume + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hostid + list volumes on specified host + false + uuid + + + id + the ID of the disk volume + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id + false + list + 4.9 + list + + + isencrypted + list only volumes that are encrypted + false + 4.19.1 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + listsystemvms + list system VMs; only ROOT admin is eligible to pass this parameter + false + 4.18 + boolean + + + name + the name of the disk volume + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod id the disk volume belongs to + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + serviceofferingid + list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored + false + 4.19.1 + uuid + + + state + state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged. + false + string + + + storageid + the ID of the storage pool, available to ROOT admin only + false + 4.3 + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + type + the type of disk volume + false + string + + + virtualmachineid + the ID of the virtual machine + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createLBHealthCheckPolicy + Creates a load balancer health check policy + true + 4.2.0 + + + lbruleid + the ID of the load balancer rule + true + uuid + + + description + the description of the load balancer health check policy + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + healthythreshold + Number of consecutive health check success before declaring an instance healthy + false + integer + + + intervaltime + Amount of time between health checks (1 sec - 20940 sec) + false + integer + + + pingpath + HTTP ping path + false + string + + + responsetimeout + Time to wait when receiving a response from the health check (2sec - 60 sec) + false + integer + + + unhealthythreshold + Number of consecutive health check failures before declaring an instance unhealthy + false + integer + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + lockUser + Locks a user account + false + + + id + Locks user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + cloudianIsEnabled + Checks if the Cloudian Connector is enabled + false + 4.11.0 + + + + enabled + the Cloudian connector enabled state + boolean + + + url + the Cloudian Management Console base URL + string + + + false + + + listNetworkOfferings + Lists all available network offerings. + false + + + availability + the availability of network offering. Default value is required + false + string + + + displaytext + list network offerings by display text + false + string + + + domainid + list network offerings available for network creation in specific domain + false + 4.13 + uuid + + + forvpc + the network offering can be used only for network creation inside the VPC + false + boolean + + + guestiptype + list network offerings by guest type: shared or isolated + false + string + + + id + list network offerings by ID + false + uuid + + + isdefault + true if need to list only default network offerings. Default value is false + false + boolean + + + istagged + true if offering has tags specified + false + boolean + + + keyword + List by keyword + false + string + + + name + list network offerings by name + false + string + + + networkid + the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to. + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + sourcenatsupported + true if need to list only netwok offerings where source NAT is supported, false otherwise + false + boolean + + + specifyipranges + true if need to list only network offerings which support specifying ip ranges + false + boolean + + + specifyvlan + the tags for the network offering. + false + boolean + + + state + list network offerings by state + false + string + + + supportedservices + list network offerings supporting certain services + false + list + list + + + tags + list network offerings by tags + false + string + + + traffictype + list by traffic type + false + string + + + zoneid + list network offerings available for network creation in specific zone + false + uuid + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + createNetwork + Creates a network + false + + + name + the name of the network + true + string + + + networkofferingid + the network offering ID + true + uuid + + + zoneid + the zone ID for the network + true + uuid + + + account + Account that will own the network. Account should be under the selected domain + false + string + + + aclid + Network ACL ID associated for the network + false + uuid + + + acltype + Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network + false + string + + + associatednetworkid + The network this network is associated to. only available if create a Shared network + false + 4.17.0 + uuid + + + bypassvlanoverlapcheck + when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks + false + boolean + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + false + boolean + + + displaytext + the display text of the network + false + string + + + dns1 + the first IPv4 DNS for the network + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the network + false + 4.18.0 + string + + + domainid + domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain. + false + uuid + + + endip + the ending IP address in the network IP range. If not specified, will be defaulted to startIP + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + externalid + ID of the network in an external system. + false + string + + + gateway + the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC + false + string + + + hideipaddressusage + when true ip address usage for the network will not be exported by the listUsageRecords API + false + boolean + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6dns1 + the first IPv6 DNS for the network + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + false + 4.18.0 + string + + + ip6gateway + the gateway of the IPv6 network. Required for Shared networks + false + string + + + isolatedpvlan + the isolated private VLAN for this network + false + string + + + isolatedpvlantype + the isolated private VLAN type for this network + false + string + + + netmask + the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC + false + string + + + networkdomain + network domain + false + string + + + physicalnetworkid + the physical network ID the network belongs to + false + uuid + + + privatemtu + MTU to be configured on the network VR's private interface(s) + false + 4.18.0 + integer + + + projectid + an optional project for the network + false + uuid + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + routerip + IPV4 address to be assigned to a router in a shared network + false + 4.16 + string + + + routeripv6 + IPV6 address to be assigned to a router in a shared network + false + 4.16 + string + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. +If an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented, + false + 4.19 + string + + + startip + the beginning IP address in the network IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + subdomainaccess + Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified + false + boolean + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + false + string + + + vlan + the ID or VID of the network + false + string + + + vpcid + the VPC network belongs to + false + uuid + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listDedicatedPods + Lists dedicated pods. + false + + + account + the name of the account associated with the pod. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated pods by affinity group + false + uuid + + + domainid + the ID of the domain associated with the pod + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the ID of the pod + false + uuid + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Pod is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the pod + string + + + domainid + the domain ID to which the Pod is dedicated + string + + + podid + the ID of the Pod + string + + + podname + the Name of the Pod + string + + + false + + + listVPCs + Lists VPCs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + cidr + list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR + false + string + + + displaytext + List by display text of the VPC + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + list VPC by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list by name of the VPC + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + restartrequired + list VPCs by restartRequired option + false + boolean + + + showicon + flag to display the resource icon for VPCs + false + boolean + + + state + list VPCs by state + false + string + + + supportedservices + list VPC supporting certain services + false + list + list + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vpcofferingid + list by ID of the VPC offering + false + uuid + + + zoneid + list by zone + false + uuid + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + runDiagnostics + Execute network-utility command (ping/arping/tracert) on system VMs remotely + true + 4.12.0.0 + + + ipaddress + The IP/Domain address to test connection to + true + string + + + targetid + The ID of the system VM instance to diagnose + true + uuid + + + type + The system VM diagnostics type valid options are: ping, traceroute, arping + true + string + + + params + Additional command line options that apply for each command + false + string + + + + + exitcode + the command execution return code + string + + + stderr + the standard error output from the command execution + string + + + stdout + the standard output from the command execution + string + + + false + + + addNetworkDevice + Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer + false + + + networkdeviceparameterlist + parameters for network device + false + map + map + + + networkdevicetype + Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall + false + string + + + + + id + the ID of the network device + string + + + false + + + restartVPC + Restarts a VPC + true + + + id + the id of the VPC + true + uuid + + + cleanup + If cleanup old network elements + false + boolean + + + livepatch + Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false. + false + 4.17.0 + boolean + + + makeredundant + Turn a single VPC into a redundant one. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteTungstenFabricApplicationPolicySet + delete Tungsten-Fabric application policy set + true + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addBaremetalDhcp + adds a baremetal dhcp server + true + + + dhcpservertype + Type of dhcp device + true + string + + + password + Credentials to reach external dhcp device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the external dhcp appliance. + true + string + + + username + Credentials to reach external dhcp device + true + string + + + + + id + device id of + string + + + dhcpservertype + name of the provider + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + copySnapshot + Copies a snapshot from one zone to another. + true + 4.19.0 + + + id + the ID of the snapshot. + true + uuid + + + destzoneid + The ID of the zone the snapshot is being copied to. + false + uuid + + + destzoneids + A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required. + false + list + list + + + sourcezoneid + The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used. + false + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addTrafficMonitor + Adds Traffic Monitor Host for Direct Network Usage + false + + + url + URL of the traffic monitor Host + true + string + + + zoneid + Zone in which to add the external firewall appliance. + true + uuid + + + excludezones + Traffic going into the listed zones will not be metered + false + string + + + includezones + Traffic going into the listed zones will be metered + false + string + + + + + id + the ID of the external firewall + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + listUsers + Lists user accounts + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accounttype + List users by account type. Valid types include admin, domain-admin, read-only-admin, or user. + false + integer + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + List user by ID. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for users + false + boolean + + + state + List users by state of the user account. + false + string + + + username + List user by the username + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + updateVlanIpRange + Updates a VLAN IP range. + false + 4.16.0 + + + id + the UUID of the VLAN IP range + true + uuid + + + endip + the ending IP address in the VLAN IP range + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + forsystemvms + true if IP range is set to system vms, false if not + false + boolean + + + gateway + the gateway of the VLAN IP range + false + string + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6gateway + the gateway of the IPv6 network + false + string + + + netmask + the netmask of the VLAN IP range + false + string + + + startip + the beginning IP address in the VLAN IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + listResourceLimits + Lists resource limits. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + Lists resource limits by ID. + false + long + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourcetype + Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + integer + + + resourcetypename + Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + string + + + + + account + the account of the resource limit + string + + + domain + the domain name of the resource limit + string + + + domainid + the domain ID of the resource limit + string + + + domainpath + path of the domain to which the resource limit belongs + 4.19.2.0 + string + + + max + the maximum number of the resource. A -1 means the resource currently has no limit. + long + + + project + the project name of the resource limit + string + + + projectid + the project id of the resource limit + string + + + resourcetype + 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. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + false + + + disableUser + Disables a user account + true + + + id + Disables user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + listIsos + Lists all available ISO files. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + bootable + true if the ISO is bootable, false otherwise + false + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + list ISO by ID + false + uuid + + + imagestoreid + ID of the image or image cache store + false + 4.19 + uuid + + + isofilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + false + string + + + ispublic + true if the ISO is publicly available to all users, false otherwise. + false + boolean + + + isready + true if this ISO is ready to be deployed + false + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list all ISOs by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the isos + false + boolean + + + showremoved + show removed ISOs as well + false + boolean + + + showunique + If set to true, list only unique isos across zones + false + 4.13.2 + boolean + + + storageid + ID of the storage pool + false + 4.19 + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + zoneid + the ID of the zone + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listAutoScalePolicies + Lists autoscale policies. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + false + string + + + conditionid + the ID of the condition of the policy + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the autoscale policy + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vmgroupid + the ID of the autoscale vm group + false + uuid + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + domainpath + path of the domain to which the autoscale policy belongs + 4.19.2.0 + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + addBaremetalRct + adds baremetal rack configuration text + true + + + baremetalrcturl + http url to baremetal RCT configuration + true + object + + + + + id + id of rct + string + + + url + url + string + + + false + + + updateRole + Updates a role + false + 4.9.0 + + + id + ID of the role + true + uuid + + + description + The description of the role + false + string + + + description + The description of the role + false + string + + + ispublic + Indicates whether the role will be visible to all users (public) or only to root admins (private). + false + boolean + + + name + creates a role with this unique name + false + string + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + listRemoteAccessVpns + Lists remote access vpns + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists remote access vpn rule with the specified ID + false + 4.3 + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list remote access VPNs for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + publicipid + public ip address id of the vpn server + false + uuid + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + deleteNetworkACLList + Deletes a network ACL + true + + + id + the ID of the network ACL + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createServiceInstance + Creates a system virtual-machine that implements network services + true + + + leftnetworkid + The left (inside) network for service instance + true + uuid + + + name + The name of the service instance + true + string + + + rightnetworkid + The right (outside) network ID for the service instance + true + uuid + + + serviceofferingid + The service offering ID that defines the resources consumed by the service appliance + true + uuid + + + templateid + The template ID that specifies the image for the service appliance + true + uuid + + + zoneid + Availability zone for the service instance + true + uuid + + + account + An optional account for the virtual machine. Must be used with domainId. + false + string + + + domainid + An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + Project ID for the service instance + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the Domain in which the virtual machine exists + 4.19.2.0 + string + + + name + the name of the virtual machine + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + false + + + removeIpFromNic + Removes secondary IP from the NIC. + true + + + id + the ID of the secondary ip address to nic + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + startSystemVm + Starts a system virtual machine. + true + + + id + The ID of the system virtual machine + true + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + registerVnfTemplate + Registers an existing VNF template into the CloudStack cloud. + false + 4.19.0 + + + format + the format for the template. Possible values include QCOW2, RAW, VHD and OVA. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the template + true + string + + + url + the URL of where the template is hosted. Possible URL include http:// and https:// + true + string + + + account + an optional accountName. Must be used with domainId. + false + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + directdownload + true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + displaytext + The display text of the template, defaults to 'name'. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Register template for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + 4.19.0 + string + + + vnfdetails + VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0 + false + map + map + + + vnfnics + VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC + false + map + map + + + zoneid + the ID of the zone the template is to be hosted on + false + uuid + + + zoneids + A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. + false + list + list + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVirtualMachinesUsageHistory + Lists VM stats + false + 4.17 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the virtual machine. + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + name + the name of the virtual machine + string + + + stats + the list of VM stats + list + + + false + + + createKubernetesCluster + Creates a Kubernetes cluster + true + + + name + name for the Kubernetes cluster + true + string + + + zoneid + availability zone in which Kubernetes cluster to be launched + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged. + false + 4.19.0 + string + + + controlnodes + number of Kubernetes cluster control nodes, default is 1 + false + long + + + description + description for the Kubernetes cluster + false + string + + + dockerregistrypassword + password for the docker image private registry + false + string + + + dockerregistryurl + URL for the docker image private registry + false + string + + + dockerregistryusername + user name for the docker image private registry + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + externalloadbalanceripaddress + external load balancer IP address while using shared network with Kubernetes HA cluster + false + string + + + keypair + name of the ssh key pair used to login to the virtual machines + false + string + + + kubernetesversionid + Kubernetes version with which cluster to be launched + false + uuid + + + masternodes + number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter. + false + long + + + networkid + Network in which Kubernetes cluster is to be launched + false + uuid + + + noderootdisksize + root disk size in GB for each node + false + long + + + projectid + Deploy cluster for the project + false + uuid + + + serviceofferingid + the ID of the service offering for the virtual machines in the cluster. + false + uuid + + + size + number of Kubernetes cluster worker nodes + false + long + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + declareHostAsDegraded + Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host. + true + 4.16.0.0 + + + id + host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listStorageNetworkIpRange + List a storage network IP range. + false + 3.0.0 + + + id + optional parameter. Storaget network IP range uuid, if specicied, using it to search the range. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range. + false + uuid + + + zoneid + optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range. + false + uuid + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + enableHAForHost + Enables HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + configureVirtualRouterElement + Configures a virtual router element. + true + + + id + the ID of the virtual router provider + true + uuid + + + enabled + Enabled/Disabled the service provider + true + boolean + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + updateVMAffinityGroup + Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. + true + + + id + The ID of the virtual machine + true + uuid + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + registerNetscalerServicePackage + Registers NCC Service Package + false + + + description + Description of Service Package + true + string + + + name + Name of the service Package. + true + string + + + + + id + Service Package UUID + string + + + description + Description of Service Package + string + + + name + Service Package Name + string + + + false + + + quotaCredits + Add +-credits to an account + false + 4.7.0 + + + account + Account Id for which quota credits need to be added + true + string + + + domainid + Domain for which quota credits need to be added + true + uuid + + + value + Value of the credits to be added+, subtracted- + true + double + + + min_balance + Minimum balance threshold of the account + false + double + + + quota_enforce + Account for which quota enforce is set to false will not be locked when there is no credit balance + false + boolean + + + + + credits + the credit deposited + bigdecimal + + + currency + currency + string + + + updated_by + the user name of the admin who updated the credits + string + + + updated_on + the account name of the admin who updated the credits + date + + + false + + + listCaCertificate + Lists the CA public certificate(s) as support by the configured/provided CA plugin + false + 4.11.0 + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + cacertificates + The CA certificate(s) + string + + + certificate + The client certificate + string + + + privatekey + Private key for the certificate + string + + + false + + + provisionTemplateDirectDownloadCertificate + Provisions a host with a direct download certificate + false + 4.17.0 + + + id + the id of the direct download certificate to provision + true + uuid + + + hostid + the host to provision the certificate + true + uuid + + + + + details + indicates the details in case of failure or host skipped + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + status + indicates if the certificate has been revoked from the host, failed or skipped + string + + + false + + + samlSlo + SAML Global Log Out API + false + + + + description + Response description + string + + + false + + + updateProjectRole + Creates a Project role + false + 4.15.0 + + + id + ID of the Project role + true + uuid + + + projectid + ID of project where role is being created + true + uuid + + + description + The description of the Project role + false + string + + + name + creates a project role with this unique name + false + string + + + + + projectid + the id of the project + string + + + false + + + addLdapConfiguration + Add a new Ldap Configuration + false + 4.2.0 + + + hostname + Hostname + true + string + + + port + Port + true + integer + + + domainid + linked domain + false + uuid + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port the ldap server is running on + int + + + false + + + createTungstenFabricAddressGroup + create Tungsten-Fabric address group + true + + + ipprefix + Tungsten-Fabric ip prefix + true + string + + + ipprefixlen + Tungsten-Fabric ip prefix length + true + integer + + + name + Tungsten-Fabric address group name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + ipprefix + Tungsten-Fabric address group ip prefix + string + + + ipprefixlen + Tungsten-Fabric address group ip prefix length + int + + + name + Tungsten-Fabric address group name + string + + + uuid + Tungsten-Fabric address group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listBigSwitchBcfDevices + Lists BigSwitch BCF Controller devices + false + 4.6.0 + + + bcfdeviceid + bigswitch BCF controller device ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + bcfdeviceid + device id of the BigSwitch BCF Controller + string + + + bigswitchdevicename + device name + string + + + hostname + the controller Ip address + string + + + nat + NAT support + boolean + + + password + the controller password + string + + + physicalnetworkid + the physical network to which this BigSwitch BCF segment belongs to + string + + + provider + name of the provider + string + + + username + the controller username + string + + + false + + + listRegisteredServicePackages + lists registered service packages + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + Service Package UUID + string + + + description + Description of Service Package + string + + + name + Service Package Name + string + + + false + + + enableStaticNat + Enables static NAT for given IP address + false + + + ipaddressid + the public IP address ID for which static NAT feature is being enabled + true + uuid + + + virtualmachineid + the ID of the virtual machine for enabling static NAT feature + true + uuid + + + networkid + The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case) + false + uuid + + + vmguestip + VM guest NIC secondary IP address for the port forwarding rule + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteZone + Deletes a Zone. + false + + + id + the ID of the Zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getUploadParamsForTemplate + upload an existing template into the CloudStack cloud. + false + 4.6.0 + + + format + the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the volume/template/iso + true + string + + + zoneid + the ID of the zone the volume/template/iso is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs. + false + map + map + + + displaytext + the display text of the template. This is usually used for display purposes. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file. + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Upload volume/template/iso for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + deleteSnapshotPolicies + Deletes snapshot policies for the account. + false + + + id + the Id of the snapshot policy + false + uuid + + + ids + list of snapshots policy IDs separated by comma + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTrafficTypeImplementors + Lists implementors of implementor of a network traffic type or implementors of all network traffic types + false + 3.0.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + traffictype + Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor + false + string + + + + + traffictype + network traffic type + string + + + traffictypeimplementor + implementor of network traffic type + string + + + false + + + listDbMetrics + list the db hosts and statistics + false + 4.17.0 + + + + collectiontime + the time these statistics were collected + date + + + connections + the number of connections to the DB + int + + + dbloadaverages + the last measured load averages on the DB + double[] + + + hostname + the name of the active usage server + string + + + queries + the number of queries performed on the DB + long + + + replicas + the state of the usage server + string[] + + + tlsversions + the tls versions currently in use (accepted) by the DB + string + + + uptime + the uptime of the DB in seconds + long + + + version + the version of the currently running DB + string + + + versioncomment + the version of the currently running DB + string + + + false + + + deleteImageStore + Deletes an image store or Secondary Storage. + false + 4.2.0 + + + id + The image store ID or Secondary Storage ID. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAutoScaleVmProfiles + Lists autoscale vm profiles. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the autoscale vm profile + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + otherdeployparams + the otherdeployparameters of the autoscale vm profile + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + serviceofferingid + list profiles by service offering id + false + 4.4 + uuid + + + templateid + the templateid of the autoscale vm profile + false + uuid + + + zoneid + availability zone for the auto deployed virtual machine + false + 4.4 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + domainpath + path of the domain to which the vm profile belongs + 4.19.2.0 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base64 encoded VM user data + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.1 + string + + + userdataid + the id of userdata used for the VM + 4.18.1 + string + + + userdataname + the name of userdata used for the VM + 4.18.1 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.1 + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + authorizeSecurityGroupIngress + Authorizes a particular ingress rule for this security group + true + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + cidrlist + the cidr list associated. Multiple entries must be separated by a single comma character (,). + false + list + list + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + endport + end port for this ingress rule + false + integer + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + projectid + an optional project of the security group + false + uuid + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default. + false + string + + + securitygroupid + The ID of the security group. Mutually exclusive with securityGroupName parameter + false + uuid + + + securitygroupname + The name of the security group. Mutually exclusive with securityGroupId parameter + false + string + + + startport + start port for this ingress rule + false + integer + + + usersecuritygrouplist + user to security group mapping + false + map + map + + + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + syncStoragePool + Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it) + true + 4.15.1 + + + id + Storage pool id + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateBucket + Updates Bucket properties + false + 4.19.0 + + + id + The ID of the Bucket + true + uuid + + + encryption + Enable/Disable Bucket encryption + false + boolean + + + policy + Bucket Access Policy + false + string + + + quota + Bucket Quota in GB + false + integer + + + versioning + Enable/Disable Bucket Versioning + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateResourceCount + Recalculate and update resource count for an account or domain. + false + + + domainid + If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain. + true + uuid + + + account + Update resource count for a specified account. Must be used with the domainId parameter. + false + string + + + projectid + Update resource limits for project + false + uuid + + + resourcetype + Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + integer + + + + + account + the account for which resource count's are updated + string + + + domain + the domain name for which resource count's are updated + string + + + domainid + the domain ID for which resource count's are updated + string + + + domainpath + path of the domain to which the resource counts are updated + 4.19.2.0 + string + + + project + the project name for which resource count's are updated + string + + + projectid + the project id for which resource count's are updated + string + + + resourcecount + resource count + long + + + resourcetype + resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + false + + + listRoles + Lists dynamic roles in CloudStack + false + 4.9.0 + + + id + List role by role ID. + false + uuid + + + keyword + List by keyword + false + string + + + name + List role by role name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + type + List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User. + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + listTungstenFabricPolicy + list Tungsten-Fabric policy + false + + + ipaddressid + the ID of ip address + false + uuid + + + keyword + List by keyword + false + string + + + networkid + the ID of network + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + downloadImageStoreObject + Download object at a specified path on an image store. + true + 4.19.0 + + + id + id of the image store + true + uuid + + + path + path to download on image store + false + string + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + getCloudIdentifier + Retrieves a cloud identifier. + false + + + userid + the user ID for the cloud identifier + true + uuid + + + + + cloudidentifier + the cloud identifier + string + + + signature + the signed response for the cloud identifier + string + + + userid + the user ID for the cloud identifier + string + + + false + + + createLBStickinessPolicy + Creates a load balancer stickiness policy + true + 3.0.0 + + + lbruleid + the ID of the load balancer rule + true + uuid + + + methodname + name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased + true + string + + + name + name of the load balancer stickiness policy + true + string + + + description + the description of the load balancer stickiness policy + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + param + param list. Example: param[0].name=cookiename&param[0].value=LBCookie + false + map + map + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + addCiscoAsa1000vResource + Adds a Cisco Asa 1000v appliance + false + + + clusterid + the Cluster ID + true + uuid + + + hostname + Hostname or ip address of the Cisco ASA 1000v appliance. + true + string + + + insideportprofile + Nexus port profile associated with inside interface of ASA 1000v + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + + false + + + configurePaloAltoFirewall + Configures a Palo Alto firewall device + true + + + fwdeviceid + Palo Alto firewall device ID + true + uuid + + + fwdevicecapacity + capacity of the firewall device, Capacity will be interpreted as number of networks device can handle + false + long + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + updateNetworkACLItem + Updates ACL item with specified ID + true + + + id + the ID of the network ACL item + true + uuid + + + action + scl entry action, allow or deny + false + string + + + cidrlist + the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + endport + the ending port of ACL + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + number + The network of the vm the ACL will be created for + false + integer + + + partialupgrade + Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'. + false + boolean + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + false + string + + + reason + A description indicating why the ACL rule is required. + false + string + + + startport + the starting port of ACL + false + integer + + + traffictype + the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listRouters + List routers. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster ID of the router + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fetchhealthcheckresults + if true is passed for this parameter, also fetch last executed health check results for the router. Default is false + false + 4.14 + boolean + + + forvpc + if true is passed for this parameter, list only VPC routers + false + boolean + + + healthchecksfailed + if this parameter is passed, list only routers by health check results + false + 4.16 + boolean + + + hostid + the host ID of the router + false + uuid + + + id + the ID of the disk router + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the router + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the router + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + the state of the router + false + string + + + version + list virtual router elements by version + false + string + + + vpcid + List networks by VPC + false + uuid + + + zoneid + the Zone ID of the router + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listTungstenFabricVm + list Tungsten-Fabric vm + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + vmuuid + the uuid of Tungsten-Fabric vm + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric vm name + string + + + uuid + Tungsten-Fabric nic uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + deletePhysicalNetwork + Deletes a Physical Network. + true + 3.0.0 + + + id + the ID of the Physical network + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addTungstenFabricPolicyRule + add Tungsten-Fabric policy rule + true + + + action + Tungsten-Fabric policy rule action + true + string + + + destendport + Tungsten-Fabric policy rule destination end port + true + integer + + + destipprefix + Tungsten-Fabric policy rule destination ip prefix + true + string + + + destipprefixlen + Tungsten-Fabric policy rule destination ip prefix length + true + integer + + + destnetwork + Tungsten-Fabric policy rule destination network + true + string + + + deststartport + Tungsten-Fabric policy rule destination start port + true + integer + + + direction + Tungsten-Fabric policy rule direction + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + protocol + Tungsten-Fabric policy rule protocol + true + string + + + srcendport + Tungsten-Fabric policy rule source end port + true + integer + + + srcipprefix + Tungsten-Fabric policy rule source ip prefix + true + string + + + srcipprefixlen + Tungsten-Fabric policy rule source ip prefix length + true + integer + + + srcnetwork + Tungsten-Fabric policy rule source network + true + string + + + srcstartport + Tungsten-Fabric policy rule source start port + true + integer + + + zoneid + the ID of zone + true + uuid + + + + + action + Tungsten-Fabric policy action + string + + + destendport + Tungsten-Fabric policy destination end port + int + + + destipprefix + Tungsten-Fabric policy destination ip prefix + string + + + destipprefixlen + Tungsten-Fabric policy destination ip prefix length + int + + + destnetwork + Tungsten-Fabric policy destination network + string + + + deststartport + Tungsten-Fabric policy destination start port + int + + + direction + Tungsten-Fabric policy name + string + + + policyuuid + Tungsten-Fabric policy uuid + string + + + protocol + Tungsten-Fabric policy protocol + string + + + srcendport + Tungsten-Fabric policy source end port + int + + + srcipprefix + Tungsten-Fabric policy source ip prefix + string + + + srcipprefixlen + Tungsten-Fabric policy source ip prefix length + int + + + srcnetwork + Tungsten-Fabric policy source network + string + + + srcstartport + Tungsten-Fabric policy source start port + int + + + uuid + Tungsten-Fabric rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + removeVpnUser + Removes vpn user + true + + + username + username for the vpn user + true + string + + + account + an optional account for the vpn user. Must be used with domainId. + false + string + + + domainid + an optional domainId for the vpn user. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + remove vpn user from the project + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listQuarantinedIps + List public IP addresses in quarantine. + false + 4.19 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + showinactive + Show IPs that are no longer in quarantine. + false + boolean + + + showremoved + Show IPs removed from quarantine. + false + boolean + + + + + id + ID of the quarantine process. + string + + + created + When the quarantine was created. + date + + + enddate + End date for the quarantine. + date + + + ipaddress + The public IP address in quarantine. + string + + + previousownerid + Account ID of the previous public IP address owner. + string + + + previousownername + Account name of the previous public IP address owner. + string + + + removalreason + The reason for removing the IP from quarantine prematurely. + string + + + removed + When the quarantine was removed. + date + + + removeraccountid + ID of the account that removed the IP from quarantine. + string + + + false + + + deleteLBHealthCheckPolicy + Deletes a load balancer health check policy. + true + 4.2.0 + + + id + the ID of the load balancer health check policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableHAForHost + Disables HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + listSwifts + List Swift. + false + 3.0.0 + + + id + the id of the swift + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + enableOutOfBandManagementForHost + Enables out-of-band management for a host + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + deleteServiceOffering + Deletes a service offering. + false + + + id + the ID of the service offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listKubernetesSupportedVersions + Lists supported Kubernetes version + false + + + id + the ID of the Kubernetes supported version + false + uuid + + + keyword + List by keyword + false + string + + + minimumkubernetesversionid + the ID of the minimum Kubernetes supported version + false + uuid + + + minimumsemanticversion + the minimum semantic version for the Kubernetes supported version to be listed + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of the zone in which Kubernetes supported version will be available + false + uuid + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + directdownload + KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage + 4.18.2 + boolean + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + addNiciraNvpDevice + Adds a Nicira NVP device + true + + + hostname + Hostname of ip address of the Nicira NVP Controller. + true + string + + + password + Credentials to access the Nicira Controller API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + transportzoneuuid + The Transportzone UUID configured on the Nicira Controller + true + string + + + username + Credentials to access the Nicira Controller API + true + string + + + l2gatewayserviceuuid + The L2 Gateway Service UUID configured on the Nicira Controller + false + string + + + l3gatewayserviceuuid + The L3 Gateway Service UUID configured on the Nicira Controller + false + string + + + + + hostname + the controller Ip address + string + + + l2gatewayserviceuuid + this L2 gateway service Uuid + string + + + l3gatewayserviceuuid + this L3 gateway service Uuid + string + + + niciradevicename + device name + string + + + nvpdeviceid + device id of the Nicire Nvp + string + + + physicalnetworkid + the physical network to which this Nirica Nvp belongs to + string + + + provider + name of the provider + string + + + transportzoneuuid + the transport zone Uuid + string + + + false + + + listInfrastructure + Lists infrastructure + false + 4.9.3 + + + + alerts + Number of Alerts + integer + + + clusters + Number of clusters + integer + + + cpusockets + Number of cpu sockets + integer + + + hosts + Number of hypervisor hosts + integer + + + ilbvms + Number of internal LBs + integer + + + imagestores + Number of images stores + integer + + + managementservers + Number of management servers + integer + + + objectstores + Number of object stores + integer + + + pods + Number of pods + integer + + + routers + Number of routers + integer + + + storagepools + Number of storage pools + integer + + + systemvms + Number of systemvms + integer + + + zones + Number of zones + integer + + + false + + + listUsageRecords + Lists usage records for accounts + false + + + enddate + End date range for usage record query (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00). + true + date + + + startdate + Start date range for usage record query (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00). + true + date + + + account + List usage records for the specified user. + false + string + + + accountid + List usage records for the specified account + false + uuid + + + domainid + List usage records for the specified domain. + false + uuid + + + includetags + Flag to enable display of Tags for a resource + false + boolean + + + isrecursive + Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account. + false + 4.15 + boolean + + + keyword + List by keyword + false + string + + + oldformat + Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + List usage records for specified project + false + uuid + + + type + List usage records for the specified usage type + false + long + + + usageid + List usage records for the specified usage UUID. Can be used only together with TYPE parameter. + false + string + + + + + account + the user account name + string + + + accountid + the user account Id + string + + + cpunumber + number of cpu of resource + long + + + cpuspeed + speed of each cpu of resource + long + + + description + description of the usage record + string + + + domain + the domain the resource is associated with + string + + + domainid + the domain ID + string + + + domainpath + path of the domain to which the usage reocrd belongs + 4.19.2.0 + string + + + enddate + end date of the usage record + string + + + isdefault + True if the resource is default + boolean + + + issourcenat + True if the IPAddress is source NAT + boolean + + + issystem + True if the IPAddress is system IP - allocated during vm deploy or lb rule create + boolean + + + memory + memory allocated for the resource + long + + + name + resource or virtual machine name + string + + + networkid + id of the network + string + + + offeringid + offering ID + string + + + oscategoryid + virtual machine guest os category ID + string + + + oscategoryname + virtual machine os category name + string + + + osdisplayname + virtual machine os display name + string + + + ostypeid + virtual machine os type ID + string + + + project + the project name of the resource + string + + + projectid + the project id of the resource + string + + + rawusage + raw usage in hours + string + + + size + resource size + long + + + startdate + start date of the usage record + string + + + templateid + template ID + string + + + type + resource type + string + + + usage + usage in hours + string + + + usageid + id of the resource + string + + + usagetype + usage type ID + integer + + + virtualmachineid + virtual machine ID + string + + + virtualsize + virtual size of resource + long + + + vpcid + id of the vpc + string + + + zoneid + the zone ID + string + + + false + + + recoverVolume + Recovers a Destroy volume. + false + 4.14.0 + + + id + The ID of the volume + true + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeTungstenFabricNetworkGatewayFromLogicalRouter + remove Tungsten-Fabric network gateway from logical router + true + + + logicalrouteruuid + Tungsten-Fabric logical router uuid + true + string + + + networkuuid + Tungsten-Fabric network uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listVolumesForImport + Lists unmanaged volumes on a storage pool + false + 4.19.1 + + + storageid + the ID of the storage pool + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the path of the volume on the storage pool + false + string + + + + + chaininfo + the chain info of the volume + string + + + details + volume details in key/value pairs. + map + + + encryptformat + the encrypt format of the volume + string + + + format + the format of the volume + string + + + fullpath + the full path of the volume + string + + + name + the name of the volume + string + + + path + the path of the volume + string + + + size + the size of the volume + long + + + storage + name of the primary storage hosting the volume + string + + + storageid + id of the primary storage hosting the volume + string + + + storagetype + type of the primary storage hosting the volume + string + + + virtualsize + the virtual size of the volume + long + + + false + + + listZonesMetrics + Lists zone metrics + false + 4.9.3 + + + available + true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false. + false + boolean + + + domainid + the ID of the domain associated with the zone + false + uuid + + + id + the ID of the zone + false + uuid + + + ids + the IDs of the zones, mutually exclusive with id + false + list + 4.19.0 + list + + + keyword + List by keyword + false + string + + + name + the name of the zone + false + string + + + networktype + the network type of the zone that the virtual machine belongs to + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the zones + false + boolean + + + showicon + flag to display the resource image for the zones + false + boolean + + + tags + List zones by resource tags (key/value pairs) + false + map + 4.3 + map + + + + + clusters + healthy / total clusters in the zone + string + + + cpuallocated + the total cpu allocated in Ghz + string + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpumaxdeviation + the maximum cpu deviation + string + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotal + the total cpu capacity in Ghz + string + + + cpuused + the total cpu used in Ghz + string + + + memoryallocated + the total cpu allocated in GiB + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorymaxdeviation + the maximum memory deviation + string + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotal + the total cpu capacity in GiB + string + + + memoryused + the total cpu used in GiB + string + + + state + state of the cluster + string + + + false + + + extractTemplate + Extracts a template + true + + + id + the ID of the template + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + url + the url to which the ISO would be extracted + false + string + + + zoneid + the ID of the zone where the ISO is originally located + false + uuid + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + expungeVirtualMachine + Expunge a virtual machine. Once expunged, it cannot be recoverd. + true + + + id + The ID of the virtual machine + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateIpAddress + Updates an IP address + true + + + id + the ID of the public IP address to update + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + 4.4 + boolean + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + migrateNetwork + moves a network to another physical network + true + 4.11.0 + + + networkid + the ID of the network + true + uuid + + + networkofferingid + network offering ID + true + uuid + + + resume + true if previous network migration cmd failed + false + boolean + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listUnmanagedInstances + Lists unmanaged virtual machines for a given cluster. + false + 4.14.0 + + + clusterid + the cluster ID + true + uuid + + + keyword + List by keyword + false + string + + + name + the hypervisor name of the instance + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + clusterid + the ID of the cluster to which virtual machine belongs + string + + + clustername + the name of the cluster to which virtual machine belongs + string + + + cpucorepersocket + the CPU cores per socket for the virtual machine. VMware specific + integer + + + cpunumber + the CPU cores of the virtual machine + integer + + + cpuspeed + the CPU speed of the virtual machine + integer + + + hostid + the ID of the host to which virtual machine belongs + string + + + hostname + the name of the host to which virtual machine belongs + string + + + memory + the memory of the virtual machine in MB + integer + + + name + the name of the virtual machine + string + + + osdisplayname + the operating system of the virtual machine + string + + + osid + the operating system ID of the virtual machine + string + + + powerstate + the power state of the virtual machine + string + + + disk(*) + the list of disks associated with the virtual machine + + + id + the ID of the disk + string + + + capacity + the capacity of the disk in bytes + long + + + controller + the controller of the disk + string + + + controllerunit + the controller unit of the disk + integer + + + datastorehost + the controller of the disk + string + + + datastorename + the controller of the disk + string + + + datastorepath + the controller of the disk + string + + + datastoretype + the controller of the disk + string + + + imagepath + the file path of the disk image + string + + + label + the label of the disk + string + + + position + the position of the disk + integer + + + set + + + nic(*) + the list of nics associated with the virtual machine + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + registerTemplate + Registers an existing template into the CloudStack cloud. + false + + + format + the format for the template. Possible values include QCOW2, RAW, VHD and OVA. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the template + true + string + + + url + the URL of where the template is hosted. Possible URL include http:// and https:// + true + string + + + account + an optional accountName. Must be used with domainId. + false + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + directdownload + true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + displaytext + The display text of the template, defaults to 'name'. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Register template for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + 4.19.0 + string + + + zoneid + the ID of the zone the template is to be hosted on + false + uuid + + + zoneids + A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. + false + list + list + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVnfAppliances + List VNF appliance owned by the account. + false + 4.19.1 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + details + comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. + false + 4.19.0 + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addStratosphereSsp + Adds stratosphere ssp server + false + + + name + stratosphere ssp api name + true + string + + + url + stratosphere ssp server url + true + string + + + zoneid + the zone ID + true + uuid + + + password + stratosphere ssp api password + false + string + + + tenantuuid + stratosphere ssp tenant uuid + false + string + + + username + stratosphere ssp api username + false + string + + + + + hostid + server id of the stratosphere ssp server + string + + + name + name + string + + + url + url of ssp endpoint + string + + + zoneid + zone which this ssp controls + string + + + false + + + createStoragePool + Creates a storage pool. + false + + + name + the name for the storage pool + true + string + + + url + the URL of the storage pool + true + string + + + zoneid + the Zone ID for the storage pool + true + uuid + + + capacitybytes + bytes CloudStack can provision from this storage pool + false + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + false + long + + + clusterid + the cluster ID for the storage pool + false + uuid + + + details + the details for the storage pool + false + map + map + + + hypervisor + hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now. + false + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + false + boolean + + + managed + whether the storage should be managed by CloudStack + false + boolean + + + podid + the Pod ID for the storage pool + false + uuid + + + provider + the storage provider name + false + string + + + scope + the scope of the storage: cluster or zone + false + string + + + tags + the tags for the storage pool + false + string + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + findStoragePoolsForMigration + Lists storage pools available for migration of a volume. + false + + + id + the ID of the volume + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteTungstenFabricFirewallRule + delete Tungsten-Fabric firewall rule + true + + + firewallruleuuid + the uuid of Tungsten-Fabric firewall rule + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableCiscoNexusVSM + disable a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be deleted + true + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + createStorageNetworkIpRange + Creates a Storage network IP range. + true + 3.0.0 + + + gateway + the gateway for storage network + true + string + + + netmask + the netmask for storage network + true + string + + + podid + UUID of pod where the ip range belongs to + true + uuid + + + startip + the beginning IP address + true + string + + + endip + the ending IP address + false + string + + + vlan + Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table + false + integer + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + configureOvsElement + Configures an ovs element. + true + + + id + the ID of the ovs provider + true + uuid + + + enabled + Enabled/Disabled the service provider + true + boolean + + + + + id + the id of the ovs + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + listSystemVmsUsageHistory + Lists System VM stats + false + 4.18.0 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the system VM. + false + uuid + + + ids + the IDs of the system VMs, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + name + the name of the virtual machine + string + + + stats + the list of VM stats + list + + + false + + + deleteIpv6FirewallRule + Deletes a IPv6 firewall rule + true + + + id + the ID of the IPv6 firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVolume + Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it. + true + + + account + the account associated with the disk volume. Must be used with the domainId parameter. + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + diskofferingid + the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in. + false + uuid + + + displayvolume + an optional field, whether to display the volume to the end user or not. + false + boolean + + + domainid + the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain. + false + uuid + + + maxiops + max iops + false + long + + + miniops + min iops + false + long + + + name + the name of the disk volume + false + string + + + projectid + the project associated with the volume. Mutually exclusive with account parameter + false + uuid + + + size + Arbitrary volume size + false + long + + + snapshotid + the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in. + false + uuid + + + virtualmachineid + the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createFirewallRule + Creates a firewall rule for a given IP address + true + + + ipaddressid + the IP address id of the port forwarding rule + true + uuid + + + protocol + the protocol for the firewall rule. Valid values are TCP/UDP/ICMP. + true + string + + + cidrlist + the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + startport + the starting port of firewall rule + false + integer + + + type + type of firewallrule: system/user + false + string + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listVMSnapshot + List virtual machine snapshot by conditions + false + 4.2.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + lists snapshot by snapshot name or display name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + state of the virtual machine snapshot + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + the ID of the vm + false + uuid + + + vmsnapshotid + The ID of the VM snapshot + false + uuid + + + vmsnapshotids + the IDs of the vm snapshots, mutually exclusive with vmsnapshotid + false + list + 4.9 + list + + + + + id + the ID of the vm snapshot + string + + + account + the account associated with the disk volume + string + + + created + the create date of the vm snapshot + date + + + current + indicates if this is current snapshot + boolean + + + description + the description of the vm snapshot + string + + + displayname + the display name of the vm snapshot + string + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the domain to which the disk volume belongs + 4.19.2.0 + string + + + hypervisor + the type of hypervisor on which snapshot is stored + string + + + name + the name of the vm snapshot + string + + + parent + the parent ID of the vm snapshot + string + + + parentName + the parent displayName of the vm snapshot + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the vm snapshot + state + + + type + VM Snapshot type + string + + + virtualmachineid + the vm ID of the vm snapshot + string + + + virtualmachinename + the vm name of the vm snapshot + 4.15.1 + string + + + zoneid + the Zone ID of the vm snapshot + string + + + zonename + the Zone name of the vm snapshot + 4.15.1 + string + + + false + + + moveNetworkAclItem + Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list + true + + + id + The ID of the network ACL rule that is being moved to a new position. + true + string + + + aclconsistencyhash + Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field). + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + nextaclruleid + The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list. + false + string + + + previousaclruleid + The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list. + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listBaremetalDhcp + list baremetal dhcp servers + false + + + physicalnetworkid + the Physical Network ID + true + uuid + + + dhcpservertype + Type of DHCP device + false + string + + + id + DHCP server device ID + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + device id of + string + + + dhcpservertype + name of the provider + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + disassociateIpAddress + Disassociates an IP address from the account. + true + + + id + the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter + false + uuid + + + ipaddress + IP Address to be disassociated. Mutually exclusive with the id parameter + false + 4.19.0 + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + enableStorageMaintenance + Puts storage pool into maintenance state + true + + + id + Primary storage ID + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeSecondaryStorageSelector + Removes an existing secondary storage selector. + false + 4.19.0 + + + id + The unique identifier of the secondary storage selector to be removed. + true + uuid + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + listApis + lists all available apis on the server, provided by the Api Discovery plugin + false + 4.1.0 + + + name + API name + false + string + + + + + description + description of the api + string + + + isasync + true if api is asynchronous + boolean + + + name + the name of the api command + string + + + related + comma separated related apis + string + + + since + version of CloudStack the api was introduced in + string + + + type + response field type + string + + + params(*) + the list params the api accepts + + + description + description of the api parameter + string + + + length + length of the parameter + int + + + name + the name of the api parameter + string + + + related + comma separated related apis to get the parameter + string + + + required + true if this parameter is required for the api request + boolean + + + since + version of CloudStack the api was introduced in + string + + + type + parameter type + string + + + set + + + response(*) + api response fields + + + description + description of the api response field + string + + + name + the name of the api response field + string + + + response + api response fields + set + + + type + response field type + string + + + set + + + false + + + deleteBaremetalRct + deletes baremetal rack configuration text + true + + + id + RCT id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVMSnapshot + Creates snapshot for a vm. + true + 4.2.0 + + + virtualmachineid + The ID of the vm + true + uuid + + + description + The description of the snapshot + false + string + + + name + The display name of the snapshot + false + string + + + quiescevm + quiesce vm if true + false + boolean + + + snapshotmemory + snapshot memory if true + false + boolean + + + + + id + the ID of the vm snapshot + string + + + account + the account associated with the disk volume + string + + + created + the create date of the vm snapshot + date + + + current + indicates if this is current snapshot + boolean + + + description + the description of the vm snapshot + string + + + displayname + the display name of the vm snapshot + string + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the domain to which the disk volume belongs + 4.19.2.0 + string + + + hypervisor + the type of hypervisor on which snapshot is stored + string + + + name + the name of the vm snapshot + string + + + parent + the parent ID of the vm snapshot + string + + + parentName + the parent displayName of the vm snapshot + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the vm snapshot + state + + + type + VM Snapshot type + string + + + virtualmachineid + the vm ID of the vm snapshot + string + + + virtualmachinename + the vm name of the vm snapshot + 4.15.1 + string + + + zoneid + the Zone ID of the vm snapshot + string + + + zonename + the Zone name of the vm snapshot + 4.15.1 + string + + + false + + + deleteLoadBalancer + Deletes an internal load balancer + true + 4.2.0 + + + id + the ID of the Load Balancer + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricTagType + Lists Tungsten-Fabric tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + tagtypeuuid + the uuid of Tungsten-Fabric tag type + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric tag type name + string + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listSSHKeyPairs + List registered keypairs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fingerprint + A public key fingerprint to look for + false + string + + + id + the ID of the ssh keypair + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + A key pair name to look for + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the keypair + string + + + domain + the domain name of the keypair owner + string + + + domainid + the domain id of the keypair owner + string + + + fingerprint + Fingerprint of the public key + string + + + name + Name of the keypair + string + + + project + the project name of the keypair owner + string + + + projectid + the project id of the keypair owner + string + + + false + + + cancelStorageMaintenance + Cancels maintenance for primary storage + true + + + id + the primary storage ID + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateSnapshotPolicy + Updates the snapshot policy. + true + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the snapshot policy to the end user or not. + false + 4.4 + boolean + + + id + the ID of the snapshot policy + false + uuid + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + zone + The list of zones in which snapshot backup is scheduled + 4.19.0 + set + + + false + + + quotaSummary + Lists balance and quota usage for all accounts + false + 4.7.0 + + + account + Optional, Account Id for which statement needs to be generated + false + string + + + domainid + Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain. + false + uuid + + + keyword + List by keyword + false + string + + + listall + Optional, to list all accounts irrespective of the quota activity + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + + + account + account name + string + + + accountid + account id + string + + + balance + account balance + bigdecimal + + + currency + currency + string + + + domain + domain name + string + + + domainid + domain id + string + + + enddate + end date + date + + + quota + quota usage of this period + bigdecimal + + + quotaenabled + if the account has the quota config enabled + boolean + + + startdate + start date + date + + + state + account state + state + + + false + + + queryAsyncJobResult + Retrieves the current status of asynchronous job. + false + + + jobid + the ID of the asynchronous job + true + uuid + + + + + account + the account that executed the async command + string + + + accountid + the account id that executed the async command + string + + + cmd + the async command executed + string + + + completed + the completed date of the job + date + + + created + the created date of the job + date + + + domainid + the domain id that executed the async command + string + + + domainpath + the domain that executed the async command + string + + + jobinstanceid + the unique ID of the instance/entity object related to the job + string + + + jobinstancetype + the instance/entity object related to the job + string + + + jobprocstatus + the progress information of the PENDING job + integer + + + jobresult + the result reason + responseobject + + + jobresultcode + the result code for the job + integer + + + jobresulttype + the result type + string + + + jobstatus + the current job status-should be 0 for PENDING + integer + + + managementserverid + the msid of the management server on which the job is running + 4.19 + long + + + userid + the user that executed the async command + string + + + jobid + the ID of the async job + + + false + + + registerNetscalerControlCenter + Adds a netscaler control center device + true + + + ipaddress + URL of the netscaler controlcenter appliance. + true + string + + + numretries + Credentials to reach netscaler controlcenter device + true + integer + + + password + Credentials to reach netscaler controlcenter device + true + string + + + username + Credentials to reach netscaler controlcenter device + true + string + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + createCounter + Adds metric counter for VM auto scaling + true + + + name + Name of the counter. + true + string + + + provider + Network provider of the counter. + true + 4.18.0 + string + + + source + Source of the counter. + true + string + + + value + Value of the counter e.g. oid in case of snmp. + true + string + + + + + id + the id of the Counter + string + + + name + Name of the counter. + string + + + provider + Provider of the counter. + string + + + source + Source of the counter. + string + + + value + Value in case of snmp or other specific counters. + string + + + zoneid + zone id of counter + string + + + false + + + listEventTypes + List Event Types + false + + + + name + Event Type + string + + + false + + + prepareForShutdown + Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted + false + 4.19.0 + + + managementserverid + the uuid of the management server + true + uuid + + + + + managementserverid + The id of the management server + long + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + removeNicFromVirtualMachine + Removes VM from specified network by deleting a NIC + true + + + nicid + NIC ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteTrafficMonitor + Deletes an traffic monitor host. + false + + + id + Id of the Traffic Monitor Host. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addCluster + Adds a new cluster + false + + + clustername + the cluster name + true + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged + true + string + + + hypervisor + hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3 + true + string + + + podid + the Pod ID for the host + true + uuid + + + zoneid + the Zone ID for the cluster + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + guestvswitchname + Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting. + false + string + + + guestvswitchtype + Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch) + false + string + + + ovm3cluster + Ovm3 native OCFS2 clustering enabled for cluster + false + string + + + ovm3pool + Ovm3 native pooling enabled for cluster + false + string + + + ovm3vip + Ovm3 vip to use for pool (and cluster) + false + string + + + password + the password for the host + false + string + + + publicvswitchname + Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting. + false + string + + + publicvswitchtype + Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch) + false + string + + + url + the URL + false + string + + + username + the username for the cluster + false + string + + + vsmipaddress + the ipaddress of the VSM associated with this cluster + false + string + + + vsmpassword + the password for the VSM associated with this cluster + false + string + + + vsmusername + the username for the VSM associated with this cluster + false + string + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + listDedicatedHosts + Lists dedicated hosts. + false + + + account + the name of the account associated with the host. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated hosts by affinity group + false + uuid + + + domainid + the ID of the domain associated with the host + false + uuid + + + hostid + the ID of the host + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the host + string + + + affinitygroupid + the Dedication Affinity Group ID of the host + string + + + domainid + the domain ID of the host + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + false + + + getDiagnosticsData + Get diagnostics and files from system VMs + true + 4.14.0.0 + + + targetid + The ID of the system VM instance to retrieve diagnostics data files from + true + uuid + + + files + A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided. + false + list + list + + + + + url + Storage URL to download retrieve diagnostics data files + string + + + false + + + getUploadParamsForIso + upload an existing ISO into the CloudStack cloud. + false + 4.13 + + + format + the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume/template/iso + true + string + + + zoneid + the ID of the zone the volume/template/iso is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + bootable + true if this ISO is bootable. If not passed explicitly its assumed to be true + false + boolean + + + checksum + the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + displaytext + the display text of the ISO. This is usually used for display purposes. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isextractable + true if the ISO or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if you want this ISO to be featured + false + boolean + + + ispublic + true if you want to register the ISO to be publicly available to all users, false otherwise. + false + boolean + + + ostypeid + the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed + false + uuid + + + projectid + Upload volume/template/iso for the project + false + uuid + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + deleteAutoScaleVmGroup + Deletes a autoscale vm group. + true + + + id + the ID of the autoscale group + true + uuid + + + cleanup + true if all VMs have to be cleaned up, false otherwise + false + 4.18.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listPaloAltoFirewalls + lists Palo Alto firewall devices in a physical network + false + + + fwdeviceid + Palo Alto firewall device ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + updateLoadBalancerRule + Updates load balancer + true + + + id + the ID of the load balancer rule to update + true + uuid + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + description + the description of the load balancer rule + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + name + the name of the load balancer rule + false + string + + + protocol + The protocol for the LB + false + string + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + enableAccount + Enables an account + false + + + account + Enables specified account. + false + string + + + domainid + Enables specified account in this domain. + false + uuid + + + id + Account id + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + changeStoragePoolScope + Changes the scope of a storage pool when the pool is in Disabled state.This feature is officially tested and supported for Hypervisors: KVM and VMware, Protocols: NFS and Ceph, and Storage Provider: DefaultPrimary. There might be extra steps involved to make this work for other hypervisors and storage options. + true + 4.19.1 + + + id + the Id of the storage pool + true + uuid + + + scope + the scope of the storage: cluster or zone + true + string + + + clusterid + the Id of the cluster to use if scope is being set to Cluster + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetwork + Deletes a network + true + + + id + the ID of the network + true + uuid + + + forced + Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + reconnectHost + Reconnects a host. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + startKubernetesCluster + Starts a stopped CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + deleteProject + Deletes a project + true + 3.0.0 + + + id + id of the project to be deleted + true + uuid + + + cleanup + true if all project resources have to be cleaned up, false otherwise + false + 4.16.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listIsoPermissions + List iso visibility and all accounts that have permissions to view this iso. + false + + + id + the template ID + true + uuid + + + + + id + the template ID + string + + + account + the list of accounts the template is available for + list + + + domainid + the ID of the domain to which the template belongs + string + + + ispublic + true if this template is a public template, false otherwise + boolean + + + projectids + the list of projects the template is available for + list + + + false + + + addNetscalerLoadBalancer + Adds a netscaler load balancer device + true + + + networkdevicetype + Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer + true + string + + + password + Credentials to reach netscaler load balancer device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the netscaler load balancer appliance. + true + string + + + username + Credentials to reach netscaler load balancer device + true + string + + + gslbprovider + true if NetScaler device being added is for providing GSLB service + false + boolean + + + gslbproviderprivateip + private IP of the site + false + string + + + gslbproviderpublicip + public IP of the site + false + string + + + isexclusivegslbprovider + true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB + false + boolean + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + restoreVolumeFromBackupAndAttachToVM + Restore and attach a backed up volume to VM + true + 4.14.0 + + + backupid + ID of the VM backup + true + uuid + + + virtualmachineid + id of the VM where to attach the restored volume + true + uuid + + + volumeid + ID of the volume backed up + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBackupSchedule + List backup schedule of a VM + false + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + intervaltype + the interval type of the backup schedule + intervaltype + + + schedule + time the backup is scheduled to be taken. + string + + + timezone + the time zone of the backup schedule + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + false + + + configTungstenFabricService + config Tungsten-Fabric service + false + + + physicalnetworkid + the ID of physical network + true + uuid + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + removeNetworkPermissions + Removes network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + accountids + a comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + accounts + a comma delimited list of accounts within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + projectids + a comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBaremetalPxeServers + list baremetal pxe server + false + + + physicalnetworkid + the Physical Network ID + true + uuid + + + id + Pxe server device ID + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + device id of + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + listLoadBalancerRules + Lists load balancer rules. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer rule + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the load balancer rule + false + string + + + networkid + list by network ID the rule belongs to + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + publicipid + the public IP address ID of the load balancer rule + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + the ID of the virtual machine of the load balancer rule + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getUser + Find user account by API key + false + + + userapikey + API key of the user + true + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + listCiscoNexusVSMs + Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster + false + + + clusterid + Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance. + false + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + createManagementNetworkIpRange + Creates a Management network IP range. + true + 4.11.0.0 + + + gateway + The gateway for the management network. + true + string + + + netmask + The netmask for the management network. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + startip + The starting IP address. + true + string + + + endip + The ending IP address. + false + string + + + forsystemvms + Specify if range is dedicated for CPVM and SSVM. + false + boolean + + + vlan + Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + addVpnUser + Adds vpn users + true + + + password + password for the username + true + string + + + username + username for the vpn user + true + string + + + account + an optional account for the vpn user. Must be used with domainId. + false + string + + + domainid + an optional domainId for the vpn user. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + add vpn user to the specific project + false + uuid + + + + + id + the vpn userID + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'. + string + + + username + the username of the vpn user + string + + + false + + + deleteBackup + Delete VM backup + true + 4.14.0 + + + id + id of the VM backup + true + uuid + + + forced + force the deletion of backup which removes the entire backup chain but keep VM in Backup Offering + false + 4.18.0.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteProjectRolePermission + Deletes a project role permission in the project + false + 4.15.0 + + + id + ID of the project role permission to be deleted + true + uuid + + + projectid + ID of the project where the project role permission is to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateQuarantinedIp + Updates the quarantine end date for the given public IP address. + false + 4.19 + + + enddate + The date when the quarantine will no longer be active. + true + date + + + id + The ID of the public IP address in active quarantine. + false + uuid + + + ipaddress + The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine. + false + string + + + + + id + ID of the quarantine process. + string + + + created + When the quarantine was created. + date + + + enddate + End date for the quarantine. + date + + + ipaddress + The public IP address in quarantine. + string + + + previousownerid + Account ID of the previous public IP address owner. + string + + + previousownername + Account name of the previous public IP address owner. + string + + + removalreason + The reason for removing the IP from quarantine prematurely. + string + + + removed + When the quarantine was removed. + date + + + removeraccountid + ID of the account that removed the IP from quarantine. + string + + + false + + + updateVnfTemplate + Updates a template to VNF template or attributes of a VNF template. + false + 4.19.0 + + + id + the ID of the image file + true + uuid + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + cleanupvnfdetails + optional boolean field, which indicates if VNF details will be cleaned up or not + false + boolean + + + cleanupvnfnics + optional boolean field, which indicates if VNF nics will be cleaned up or not + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + string + + + vnfdetails + VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0 + false + map + map + + + vnfnics + VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC + false + map + map + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateVPCOffering + Updates VPC offering + true + + + id + the id of the VPC offering + true + uuid + + + displaytext + the display text of the VPC offering + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + name + the name of the VPC offering + false + string + + + sortkey + sort key of the VPC offering, integer + false + integer + + + state + update state for the VPC offering; supported states - Enabled/Disabled + false + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + listSamlAuthorization + Lists authorized users who can used SAML SSO + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + userid + User uuid + false + uuid + + + + + idpid + the authorized Identity Provider ID + string + + + status + the SAML authorization status + boolean + + + userid + the user ID + string + + + false + + + listUserTwoFactorAuthenticatorProviders + Lists user two factor authenticator providers + false + 4.18.0 + + + name + List user two factor authenticator provider by name + false + string + + + + + description + the description of the user two factor authenticator provider + string + + + name + the user two factor authenticator provider name + string + + + false + + + scaleVirtualMachine + Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume. + true + + + id + The ID of the virtual machine + true + uuid + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + automigrate + Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering + false + 4.17 + boolean + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + maxiops + New maximum number of IOPS for the custom disk offering + false + 4.17 + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + 4.17 + long + + + shrinkok + Verify OK to Shrink + false + 4.17 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateEgressFirewallRule + Updates egress firewall rule + true + 4.4 + + + id + the ID of the egress firewall rule + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listOsCategories + Lists all supported OS categories for this cloud. + false + + + id + list Os category by id + false + uuid + + + keyword + List by keyword + false + string + + + name + list os category by name + false + 3.0.1 + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the OS category + string + + + name + the name of the OS category + string + + + false + + + listServiceOfferings + Lists all available service offerings. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + cpunumber + the CPU number that listed offerings must support + false + 4.15 + integer + + + cpuspeed + the CPU speed that listed offerings must support + false + 4.15 + integer + + + domainid + list only resources belonging to the domain specified + false + uuid + + + encryptroot + listed offerings support root disk encryption + false + 4.18 + boolean + + + id + ID of the service offering + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issystem + is this a system vm offering + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + memory + the RAM memory that listed offering must support + false + 4.15 + integer + + + name + name of the service offering + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings. + false + 4.19 + string + + + storagetype + the storage type of the service offering. Values are local and shared. + false + 4.19 + string + + + systemvmtype + the system VM type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter". + false + string + + + virtualmachineid + the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to. + false + uuid + + + zoneid + id of zone disk offering is associated with + false + 4.13 + uuid + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + state + state of the service offering + string + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + importVm + Import virtual machine from a unmanaged host into CloudStack + true + 4.19.0 + + + clusterid + the cluster ID + true + uuid + + + hypervisor + hypervisor type of the host + true + string + + + importsource + Source location for Import + true + string + + + name + the name of the instance as it is known to the hypervisor + true + string + + + serviceofferingid + the service offering for the virtual machine + true + uuid + + + zoneid + the zone ID + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + clustername + (only for importing VMs from VMware to KVM) Name of VMware cluster. + false + string + + + convertinstancehostid + (only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM. + false + uuid + + + convertinstancepoolid + (only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM. + false + uuid + + + datacentername + (only for importing VMs from VMware to KVM) Name of VMware datacenter. + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping using keys disk and diskOffering + false + map + map + + + details + used to specify the custom parameters. + false + map + map + + + diskpath + path of the disk image + false + string + + + displayname + the display name of the instance + false + string + + + domainid + import instance to the domain specified + false + uuid + + + existingvcenterid + (only for importing VMs from VMware to KVM) UUID of a linked existing vCenter + false + uuid + + + forced + VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated + false + boolean + + + forcemstoimportvmfiles + (only for importing VMs from VMware to KVM) optional - if true, forces MS to export OVF from VMware to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not. + false + boolean + + + host + the host name or IP address + false + string + + + hostid + Host where local disk is located + false + uuid + + + hostip + (only for importing VMs from VMware to KVM) VMware ESXi host IP/Name. + false + string + + + hostname + the host name of the instance + false + string + + + importinstancehostid + (only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM. + false + 4.19.2 + uuid + + + migrateallowed + vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool + false + boolean + + + networkid + the network ID + false + uuid + + + nicipaddresslist + VM nic to ip address mapping using keys nic, ip4Address + false + map + map + + + nicnetworklist + VM nic to network id mapping using keys nic and network + false + map + map + + + password + the password for the host + false + string + + + projectid + import instance for the project + false + uuid + + + storageid + Shared storage pool where disk is located + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + temppath + Temp Path on external host for disk image copy + false + string + + + username + the username for the host + false + string + + + vcenter + (only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeFromGlobalLoadBalancerRule + Removes a load balancer rule association with global load balancer rule + true + + + id + The ID of the load balancer rule + true + uuid + + + loadbalancerrulelist + the list load balancer rules that will be assigned to global load balancer rule + true + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAffinityGroupTypes + Lists affinity group types available + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + type + the type of the affinity group + string + + + false + + + listCapacity + Lists all the system wide capacities. + false + + + clusterid + lists capacity by the Cluster ID + false + 3.0.0 + uuid + + + fetchlatest + recalculate capacities and fetch the latest + false + 3.0.0 + boolean + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists capacity by the Pod ID + false + uuid + + + sortby + Sort the results. Available values: Usage + false + 3.0.0 + string + + + type + lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90. + false + integer + + + zoneid + lists capacity by the Zone ID + false + uuid + + + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + false + + + updateServiceOffering + Updates a service offering. + false + + + id + the ID of the service offering to be updated + true + uuid + + + displaytext + the display text of the service offering to be updated + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + hosttags + the host tag for this service offering. + false + 4.16 + string + + + name + the name of the service offering to be updated + false + string + + + sortkey + sort key of the service offering, integer + false + integer + + + state + state of the service offering + false + string + + + storagetags + comma-separated list of tags for the service offering, tags should match with existing storage pool tags + false + 4.16 + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + state + state of the service offering + string + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + stopVirtualMachine + Stops a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createNetworkACLList + Creates a network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone. + true + + + name + Name of the network ACL list + true + string + + + description + Description of the network ACL list + false + string + + + fordisplay + an optional field, whether to the display the list to the end user or not + false + 4.4 + boolean + + + vpcid + ID of the VPC associated with this network ACL list + false + uuid + + + + + id + the ID of the ACL + string + + + description + Description of the ACL + string + + + fordisplay + is ACL for display to the regular user + 4.4 + boolean + + + name + the Name of the ACL + string + + + vpcid + Id of the VPC this ACL is associated with + string + + + vpcname + Name of the VPC this ACL is associated with + string + + + false + + \ No newline at end of file diff --git a/4.19.3_commands.xml b/4.19.3_commands.xml new file mode 100644 index 0000000..59f36bd --- /dev/null +++ b/4.19.3_commands.xml @@ -0,0 +1,130714 @@ + + + createVPCOffering + Creates VPC offering + true + + + name + the name of the vpc offering + true + string + + + supportedservices + services supported by the vpc offering + true + list + list + + + displaytext + the display text of the vpc offering, defaults to the 'name' + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + enable + set to true if the offering is to be enabled during creation. Default is false + false + 4.16 + boolean + + + internetprotocol + The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6 + false + 4.17.0 + string + + + servicecapabilitylist + desired service capabilities as part of vpc offering + false + map + 4.4 + map + + + serviceofferingid + the ID of the service offering for the VPC router appliance + false + uuid + + + serviceproviderlist + provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network + false + map + map + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + ldapCreateAccount + Creates an account from an LDAP user + false + 4.2.0 + + + username + Unique username. + true + string + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accountid + Account UUID, required for adding account from external provisioning system + false + string + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + Creates the user under the specified domain. + false + uuid + + + networkdomain + Network domain for the account's networks + false + string + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + copyIso + Copies an iso from one zone to another. + true + + + id + Template ID. + true + uuid + + + destzoneid + ID of the zone the template is being copied to. + false + uuid + + + destzoneids + 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. + false + list + list + + + sourcezoneid + 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. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteAutoScaleVmProfile + Deletes a autoscale vm profile. + true + + + id + the ID of the autoscale profile + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVsphereStoragePolicyCompatiblePools + List storage pools compatible with a vSphere storage policy + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + policyid + ID of the storage policy + false + uuid + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + rebootSystemVm + Reboots a system VM. + true + + + id + The ID of the system virtual machine + true + uuid + + + forced + Force reboot the system VM (System VM is Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + listDedicatedZones + List dedicated zones. + false + + + account + the name of the account associated with the zone. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated zones by affinity group + false + uuid + + + domainid + the ID of the domain associated with the zone + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of the Zone + false + uuid + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Zone is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the zone + string + + + domainid + the domain ID to which the Zone is dedicated + string + + + zoneid + the ID of the Zone + string + + + zonename + the Name of the Zone + string + + + false + + + listElastistorPool + Lists the pools of elastistor + false + + + id + the ID of the Pool + false + long + + + + + id + the ID of the storage pool + string + + + controllerid + controller of the pool + string + + + gateway + default gateway of the pool + string + + + maxiops + available iops of the pool + long + + + name + the name of the storage pool + string + + + size + the current available space of the pool + long + + + state + the state of the storage pool + string + + + false + + + listTungstenFabricLBHealthMonitor + list Tungsten-Fabric LB health monitor + false + + + lbruleid + the ID of lb rule + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the health monitor ID + long + + + expectedcode + the health monitor expected code + string + + + httpmethod + the health monitor http method + string + + + interval + the health monitor interval + int + + + lbruleid + the LB rule ID + string + + + retry + the health monitor retry + int + + + timeout + the health monitor timeout + int + + + type + the health monitor type + string + + + urlpath + the health monitor url path + string + + + uuid + the health monitor UUID + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + deleteAccountFromProject + Deletes account from the project + true + 3.0.0 + + + account + name of the account to be removed from the project + true + string + + + projectid + ID of the project to remove the account from + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateGuestOs + Updates the information about Guest OS + true + 4.4.0 + + + id + UUID of the Guest OS + true + uuid + + + osdisplayname + Unique display name for Guest OS + true + string + + + details + Map of (key/value pairs) + false + map + map + + + forDisplay + whether this guest OS is available for end users + false + boolean + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + fordisplay + is the guest OS visible for the users + boolean + + + isuserdefined + is the guest OS user defined + boolean + + + name + the name of the OS type + string + + + oscategoryid + the ID of the OS category + string + + + oscategoryname + the name of the OS category + string + + + false + + + listGuestVlans + Lists all guest vlans + false + 4.17.0 + + + allocatedonly + limits search results to allocated guest vlan. false by default. + false + boolean + + + id + list guest vlan by id + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + list guest vlan by physical network + false + uuid + + + vnet + list guest vlan by vnet + false + string + + + zoneid + list guest vlan by zone + false + uuid + + + + + id + the guest VLAN id + long + + + account + the account of the guest VLAN range + string + + + allocationstate + the allocation state of the guest VLAN + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + domainpath + path of the domain to which the guest VLAN range belongs + 4.19.2.0 + string + + + isdedicated + true if the guest VLAN is dedicated to the account + boolean + + + network + the list of networks who use this guest VLAN + list + + + physicalnetworkid + the physical network ID of the guest VLAN range + string + + + physicalnetworkname + the physical network name of the guest VLAN range + string + + + project + the project name of the guest VLAN range + string + + + projectid + the project id of the guest VLAN range + string + + + taken + date the guest VLAN was taken + date + + + vlan + the guest VLAN + string + + + zoneid + the zone ID of the guest VLAN range + string + + + zonename + the zone name of the guest VLAN range + string + + + false + + + updateResourceLimit + Updates resource limits for an account or domain. + false + + + resourcetype + Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + true + integer + + + account + Update resource for a specified account. Must be used with the domainId parameter. + false + string + + + domainid + 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. + false + uuid + + + max + Maximum resource limit. + false + long + + + projectid + Update resource limits for project + false + uuid + + + + + account + the account of the resource limit + string + + + domain + the domain name of the resource limit + string + + + domainid + the domain ID of the resource limit + string + + + domainpath + path of the domain to which the resource limit belongs + 4.19.2.0 + string + + + max + the maximum number of the resource. A -1 means the resource currently has no limit. + long + + + project + the project name of the resource limit + string + + + projectid + the project id of the resource limit + string + + + resourcetype + 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. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + false + + + getLoadBalancerSslCertificate + get load balancer certificate + false + + + id + the ID of Lb + true + uuid + + + + + chain + chain + string + + + crt + crt + string + + + key + key + string + + + false + + + deleteStaticRoute + Deletes a static route + true + + + id + the ID of the static route + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteRemoteAccessVpn + Destroys a l2tp/ipsec remote access vpn + true + + + publicipid + public ip address id of the vpn server + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + startRollingMaintenance + Start rolling maintenance + true + + + clusterids + the IDs of the clusters to start maintenance on + false + list + list + + + forced + if rolling mechanism should continue in case of an error + false + boolean + + + hostids + the IDs of the hosts to start maintenance on + false + list + list + + + payload + the command to execute while hosts are on maintenance + false + string + + + podids + the IDs of the pods to start maintenance on + false + list + list + + + timeout + optional operation timeout (in seconds) that overrides the global timeout setting + false + integer + + + zoneids + the IDs of the zones to start maintenance on + false + list + list + + + + + details + in case of failure, details are displayed + string + + + success + indicates if the rolling maintenance operation was successful + boolean + + + hostsskipped(*) + the hosts skipped + + + hostid + the ID of the skipped host + string + + + hostname + the name of the skipped host + string + + + reason + the reason to skip the host + string + + + list + + + hostsupdated(*) + the hosts updated + + + enddate + end date of the update on the host + string + + + hostid + the ID of the updated host + string + + + hostname + the name of the updated host + string + + + output + output of the maintenance script on the host + string + + + startdate + start date of the update on the host + string + + + list + + + false + + + listTungstenFabricApplicationPolicySet + list Tungsten-Fabric application policy set + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + firewallpolicy + list Tungsten-Fabric firewall policy + list + + + name + Tungsten-Fabric policy name + string + + + tag + list Tungsten-Fabric tag + list + + + uuid + Tungsten-Fabric application policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateNetworkACLList + Updates network ACL list + true + 4.4 + + + id + the ID of the network ACL + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + description + Description of the network ACL list + false + string + + + fordisplay + an optional field, whether to the display the list to the end user or not + false + 4.4 + boolean + + + name + Name of the network ACL list + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + restoreVirtualMachine + Restore a VM to original template/ISO or new template/ISO + true + 3.0.0 + + + virtualmachineid + Virtual Machine ID + true + uuid + + + details + used to specify the custom parameters + false + map + 4.19.1 + map + + + diskofferingid + Override root volume's diskoffering. + false + 4.19.1 + uuid + + + expunge + Optional field to expunge old root volume after restore. + false + 4.19.1 + boolean + + + rootdisksize + Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.19.1 + long + + + templateid + 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 + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteNiciraNvpDevice + delete a nicira nvp device + true + + + nvpdeviceid + Nicira device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + notifyBaremetalProvisionDone + Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user + true + + + mac + mac of the nic used for provision + true + object + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUcsBlades + List ucs blades + false + + + ucsmanagerid + ucs manager id + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + ucs blade id + string + + + bladedn + ucs blade dn + string + + + hostid + cloudstack host id this blade associates to + string + + + profiledn + associated ucs profile dn + string + + + ucsmanagerid + ucs manager id + string + + + false + + + getVolumeSnapshotDetails + Get Volume Snapshot Details + false + + + snapshotid + CloudStack Snapshot UUID + true + string + + + + + volumeiScsiName + Volume iSCSI Name + string + + + false + + + updateHost + Updates a host. + false + + + id + the ID of the host to update + true + uuid + + + allocationstate + Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable + false + string + + + annotation + Add an annotation to this host + false + 4.11 + string + + + hosttags + list of tags to be added to the host + false + list + list + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + false + boolean + + + name + Change the name of host + false + 4.15 + string + + + oscategoryid + the id of Os category to update the host with + false + uuid + + + url + the new uri for the secondary storage: nfs://host/path + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createEgressFirewallRule + Creates a egress firewall rule for a given network + true + + + networkid + the network id of the port forwarding rule + true + uuid + + + protocol + the protocol for the firewall rule. Valid values are TCP/UDP/ICMP. + true + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + destcidrlist + the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + startport + the starting port of firewall rule + false + integer + + + type + type of firewallrule: system/user + false + string + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listSecurityGroups + Lists security groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list the security group by the id provided + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + securitygroupname + lists security groups by name + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + lists security groups by virtual machine id + false + uuid + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listOauthProvider + List OAuth providers registered + false + 4.19.0 + + + id + the ID of the OAuth provider + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + Name of the provider + false + string + + + + + id + ID of the provider + string + + + clientid + Client ID registered in the OAuth provider + string + + + description + Description of the provider registered + string + + + enabled + Whether the OAuth provider is enabled or not + boolean + + + name + Name of the provider + string + + + provider + Name of the provider + string + + + redirecturi + Redirect URI registered in the OAuth provider + string + + + secretkey + Secret key registered in the OAuth provider + string + + + false + + + deleteServicePackageOffering + Delete Service Package + false + + + id + the service offering ID + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + destroySystemVm + Destroys a system virtual machine. + true + + + id + The ID of the system virtual machine + true + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + archiveEvents + Archive one or more events. + false + + + enddate + end date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the events + false + list + list + + + startdate + start date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + archive by event type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSecondaryStagingStore + Deletes a secondary staging store . + false + 4.2.0 + + + id + the staging store ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUserData + List registered userdatas + false + 4.18 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the Userdata + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + Userdata name to look for + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the userdata + string + + + accountid + the owner id of the userdata + string + + + domain + the domain name of the userdata owner + string + + + domainid + the domain id of the userdata owner + string + + + domainpath + path of the domain to which the userdata owner belongs + 4.19.2.0 + string + + + name + Name of the userdata + string + + + params + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + string + + + project + the project name of the userdata + 4.19.1 + string + + + projectid + the project id of the userdata + 4.19.1 + string + + + userdata + base64 encoded userdata content + string + + + false + + + updateLoadBalancer + Updates an internal load balancer + true + 4.4.0 + + + id + the ID of the load balancer + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + domainpath + path of the domain to which the Load Balancer belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + scaleSystemVm + Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect. + true + + + id + The ID of the system vm + true + uuid + + + serviceofferingid + the service offering ID to apply to the system vm + true + uuid + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + verifyOAuthCodeAndGetUser + Verify the OAuth Code and fetch the corresponding user from provider + false + 4.19.0 + + + provider + Name of the provider + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + secretcode + Code that is provided by OAuth provider (Eg. google, github) after successful login + false + string + + + + + id + ID of the provider + string + + + clientid + Client ID registered in the OAuth provider + string + + + description + Description of the provider registered + string + + + enabled + Whether the OAuth provider is enabled or not + boolean + + + name + Name of the provider + string + + + provider + Name of the provider + string + + + redirecturi + Redirect URI registered in the OAuth provider + string + + + secretkey + Secret key registered in the OAuth provider + string + + + false + + + listClusterDrsPlan + List DRS plans for a clusters + false + 4.19.0 + + + clusterid + ID of the cluster + false + uuid + + + id + ID of the drs plan + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + unique ID of the drs plan for cluster + string + + + clusterid + Id of the cluster + string + + + eventid + Start event Id of the DRS Plan + string + + + migrations + List of migrations + list + + + status + Status of DRS Plan + status + + + type + Type of DRS Plan (Automated or Manual)) + type + + + false + + + listClusters + Lists clusters. + false + + + allocationstate + lists clusters by allocation state + false + string + + + clustertype + lists clusters by cluster type + false + string + + + hypervisor + lists clusters by hypervisor type + false + string + + + id + lists clusters by the cluster ID + false + uuid + + + keyword + List by keyword + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + name + lists clusters by the cluster name + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists clusters by Pod ID + false + uuid + + + showcapacities + flag to display the capacity of the clusters + false + boolean + + + zoneid + lists clusters by Zone ID + false + uuid + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + listProjectInvitations + Lists project invitations and provides detailed information for listed invitations + false + 3.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + activeonly + if true, list only active invitations - having Pending state and ones that are not timed out yet + false + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list invitations by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list by project id + false + uuid + + + state + list invitations by state + false + string + + + userid + list invitation by user ID + false + uuid + + + + + id + the id of the invitation + string + + + account + the account name of the project's owner + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + domainpath + path of the Domain the project belongs to + 4.19.2.0 + string + + + email + the email the invitation was sent to + string + + + project + the name of the project + string + + + projectid + the id of the project + string + + + state + the invitation state + string + + + userid + the User ID + string + + + false + + + listEgressFirewallRules + Lists all egress firewall rules for network ID. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the firewall services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + the network ID for the egress firewall services + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listClustersMetrics + Lists clusters metrics + false + 4.9.3 + + + allocationstate + lists clusters by allocation state + false + string + + + clustertype + lists clusters by cluster type + false + string + + + hypervisor + lists clusters by hypervisor type + false + string + + + id + lists clusters by the cluster ID + false + uuid + + + keyword + List by keyword + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + name + lists clusters by the cluster name + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists clusters by Pod ID + false + uuid + + + showcapacities + flag to display the capacity of the clusters + false + boolean + + + zoneid + lists clusters by Zone ID + false + uuid + + + + + cpuallocated + the total cpu allocated in Ghz + string + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpumaxdeviation + the maximum cpu deviation + string + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotal + the total cpu capacity in Ghz + string + + + cpuused + the total cpu used in Ghz + string + + + drsimbalance + DRS imbalance for the cluster + string + + + hosts + running / total hosts in the cluster + string + + + memoryallocated + the total cpu allocated in GiB + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorymaxdeviation + the maximum memory deviation + string + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotal + the total cpu capacity in GiB + string + + + memoryused + the total cpu used in GiB + string + + + state + state of the cluster + string + + + false + + + createBackupSchedule + Creates a user-defined VM backup schedule + false + 4.14.0 + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + schedule + custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + date + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + listStoragePoolObjects + Lists objects at specified path on a storage pool. + false + 4.19.0 + + + id + id of the storage pool + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + path to list on storage pool + false + string + + + + + format + Format of template associated with the data store object. + string + + + isdirectory + Is it a directory. + boolean + + + lastupdated + Last modified date of the file/directory. + date + + + name + Name of the data store object. + string + + + size + Size is in Bytes. + long + + + snapshotid + Snapshot ID associated with the data store object. + string + + + templateid + Template ID associated with the data store object. + string + + + volumeid + Volume ID associated with the data store object. + string + + + false + + + listSecondaryStagingStores + Lists secondary staging stores. + false + 4.2.0 + + + id + the ID of the staging store + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the staging store + false + string + + + page + false + integer + + + pagesize + false + integer + + + protocol + the staging store protocol + false + string + + + provider + the staging store provider + false + string + + + zoneid + the Zone ID for the staging store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + startRouter + Starts a router. + true + + + id + the ID of the router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + resetConfiguration + Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings + false + 4.16.0 + + + name + the name of the configuration + true + string + + + accountid + the ID of the Account to reset the parameter value for corresponding account + false + uuid + + + clusterid + the ID of the Cluster to reset the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to reset the parameter value for corresponding domain + false + uuid + + + imagestoreid + the ID of the Image Store to reset the parameter value for corresponding image store + false + uuid + + + storageid + the ID of the Storage pool to reset the parameter value for corresponding storage pool + false + uuid + + + zoneid + the ID of the Zone to reset the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + createAutoScalePolicy + Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group. + true + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + true + string + + + conditionids + the list of IDs of the conditions that are being evaluated on every interval + true + list + list + + + duration + the duration in which the conditions have to be true before action is taken + true + integer + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + quiettime + the cool down period in which the policy should not be evaluated after the action has been taken + false + integer + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + domainpath + path of the domain to which the autoscale policy belongs + 4.19.2.0 + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + deleteStratosphereSsp + Removes stratosphere ssp server + false + + + hostid + the host ID of ssp server + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUsageServerMetrics + Lists Usage Server metrics + false + 4.17.0 + + + + collectiontime + the time these statistics were collected + date + + + hostname + the name of the active usage server + string + + + lastheartbeat + the last time this Usage Server checked for jobs + date + + + lastsuccessfuljob + the last time a usage job successfully completed + date + + + state + the state of the usage server + state + + + false + + + enableHAForZone + Enables HA for a zone + true + 4.11 + + + zoneid + ID of the zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + cleanVMReservations + Cleanups VM reservations in the database. + true + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listObjectStoragePools + Lists object storage pools. + false + 4.19.0 + + + id + the ID of the storage pool + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the object store + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + the object store provider + false + string + + + + + id + the ID of the object store + string + + + name + the name of the object store + string + + + providername + the provider name of the object store + string + + + storagetotal + the total size of the object store + long + + + storageused + the object store currently used size + long + + + url + the url of the object store + string + + + false + + + createSecondaryStagingStore + create secondary staging store. + false + + + url + the URL for the staging store + true + string + + + details + the details for the staging store + false + map + map + + + provider + the staging store provider name + false + string + + + scope + the scope of the staging store: zone only for now + false + string + + + zoneid + the Zone ID for the staging store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + removeVmwareDc + Remove a VMware datacenter from a zone. + false + + + zoneid + The id of Zone from which VMware datacenter has to be removed. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateLBHealthCheckPolicy + Updates load balancer health check policy + true + 4.4 + + + id + ID of load balancer health check policy + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + removeTungstenFabricPolicyRule + remove Tungsten-Fabric policy + true + + + policyuuid + the Uuid of Tungsten-Fabric policy + true + string + + + ruleuuid + the Uuid of Tungsten-Fabric policy rule + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createLoadBalancerRule + Creates a load balancer rule + true + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + true + string + + + name + name of the load balancer rule + true + string + + + privateport + the private port of the private IP address/virtual machine where the network traffic will be load balanced to + true + integer + + + publicport + the public port from where the network traffic will be load balanced from + true + integer + + + account + the account associated with the load balancer. Must be used with the domainId parameter. + false + string + + + cidrlist + the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed. + false + list + 4.18.0.0 + list + + + description + the description of the load balancer rule + false + string + + + domainid + the domain ID associated with the load balancer + false + uuid + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + networkid + The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case) + false + uuid + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true + false + boolean + + + protocol + The protocol for the LB such as tcp, udp or tcp-proxy. + false + string + + + publicipid + public IP address ID from where the network traffic will be load balanced from + false + uuid + + + zoneid + zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm + false + uuid + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + importVsphereStoragePolicies + Import vSphere storage policies + false + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the Storage Policy + string + + + description + the description of the Storage Policy + string + + + name + the name of the Storage Policy + string + + + policyid + the identifier of the Storage Policy in vSphere DataCenter + string + + + zoneid + the ID of the Zone + string + + + false + + + disableOutOfBandManagementForZone + Disables out-of-band management for a zone + true + 4.9.0 + + + zoneid + the ID of the zone + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + createBackup + Create VM backup + true + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listIpv6FirewallRules + Lists all IPv6 firewall rules + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + boolean + + + id + Lists ipv6 firewall rule with the specified ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list ipv6 firewall rules by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + list ipv6 firewall rules by traffic type - ingress or egress + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateVPC + Updates a VPC + true + + + id + the id of the VPC + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displaytext + the display text of the VPC + false + string + + + fordisplay + an optional field, whether to the display the vpc to the end user or not + false + 4.4 + boolean + + + name + the name of the VPC + false + string + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC + false + 4.19 + string + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + stopSystemVm + Stops a system VM. + true + + + id + The ID of the system virtual machine + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + deleteEgressFirewallRule + Deletes an egress firewall rule + true + + + id + the ID of the firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVMSchedule + List VM Schedules. + false + 4.19.0 + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + action + Action taken by schedule + false + string + + + enabled + ID of VM schedule + false + boolean + + + id + ID of VM schedule + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of VM schedule + string + + + action + Action + action + + + created + Date when the schedule was created + date + + + description + Description of VM schedule + string + + + enabled + VM schedule is enabled + boolean + + + enddate + Date after which the schedule becomes inactive + date + + + schedule + Cron formatted VM schedule + string + + + startdate + Date from which the schedule is active + date + + + timezone + Timezone of the schedule + string + + + virtualmachineid + ID of virtual machine + string + + + false + + + patchSystemVm + Attempts to live patch systemVMs - CPVM, SSVM + true + 4.17.0 + + + forced + If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only + false + boolean + + + id + patches systemVM - CPVM/SSVM with the specified ID + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVolumesMetrics + Lists volume metrics + false + 4.9.3 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster id the disk volume belongs to + false + uuid + + + diskofferingid + list volumes by disk offering + false + 4.4 + uuid + + + displayvolume + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hostid + list volumes on specified host + false + uuid + + + id + the ID of the disk volume + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id + false + list + 4.9 + list + + + isencrypted + list only volumes that are encrypted + false + 4.19.1 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + listsystemvms + list system VMs; only ROOT admin is eligible to pass this parameter + false + 4.18 + boolean + + + name + the name of the disk volume + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod id the disk volume belongs to + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + serviceofferingid + list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored + false + 4.19.1 + uuid + + + state + state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged. + false + string + + + storageid + the ID of the storage pool, available to ROOT admin only + false + 4.3 + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + type + the type of disk volume + false + string + + + virtualmachineid + the ID of the virtual machine + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + diskiopstotal + the total disk iops + long + + + sizegb + disk size in GiB + string + + + false + + + listDetailOptions + Lists all possible details and their options for a resource type such as a VM or a template + false + 4.13 + + + resourcetype + the resource type such as UserVm, Template etc. + true + string + + + resourceid + the UUID of the resource (optional) + false + string + + + + + details + Map of all possible details and their possible list of values + map + + + false + + + listSslCerts + Lists SSL certificates + false + + + accountid + Account ID + false + uuid + + + certid + ID of SSL certificate + false + uuid + + + lbruleid + Load balancer rule ID + false + uuid + + + projectid + Project that owns the SSL certificate + false + uuid + + + + + id + SSL certificate ID + string + + + account + account for the certificate + string + + + certchain + certificate chain + string + + + certificate + certificate + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + fingerprint + certificate fingerprint + string + + + loadbalancerrulelist + List of loabalancers this certificate is bound to + list + + + name + name + string + + + project + the project name of the certificate + string + + + projectid + the project id of the certificate + string + + + false + + + listPrivateGateways + List private gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list private gateway by id + false + uuid + + + ipaddress + list gateways by ip address + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + list gateways by state + false + string + + + vlan + list gateways by vlan + false + string + + + vpcid + list gateways by vpc + false + uuid + + + + + id + the id of the private gateway + string + + + account + the account associated with the private gateway + string + + + aclid + ACL Id set for private gateway + string + + + aclname + ACL name set for private gateway + string + + + domain + the domain associated with the private gateway + string + + + domainid + the ID of the domain associated with the private gateway + string + + + domainpath + path of the domain to which the private gateway belongs + 4.19.2.0 + string + + + gateway + the gateway + string + + + ipaddress + the private gateway's ip address + string + + + netmask + the private gateway's netmask + string + + + physicalnetworkid + the physical network id + string + + + project + the project name of the private gateway + string + + + projectid + the project id of the private gateway + string + + + sourcenatsupported + Source Nat enable status + boolean + + + state + State of the gateway, can be Creating, Ready, Deleting + string + + + vlan + the network implementation uri for the private gateway + string + + + vpcid + VPC id the private gateway belongs to + string + + + vpcname + VPC name the private gateway belongs to + 4.13.2 + string + + + zoneid + zone id of the private gateway + string + + + zonename + the name of the zone the private gateway belongs to + string + + + false + + + updateVmNicIp + Update the default Ip of a VM Nic + true + + + nicid + the ID of the nic to which you want to assign private IP + true + uuid + + + ipaddress + Secondary IP Address + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + startInternalLoadBalancerVM + Starts an existing internal lb vm. + true + + + id + the ID of the internal lb vm + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateDiskOffering + Updates a disk offering. + false + + + id + ID of the disk offering + true + uuid + + + bytesreadrate + bytes read rate of the disk offering + false + 4.15 + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + 4.15 + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + byteswriterate + bytes write rate of the disk offering + false + 4.15 + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + 4.15 + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + cachemode + the cache mode to use for this disk offering + false + 4.15 + string + + + displayoffering + an optional field, whether to display the offering to the end user or not. + false + boolean + + + displaytext + updates alternate display text of the disk offering with this value + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + 4.13 + string + + + iopsreadrate + io requests read rate of the disk offering + false + 4.15 + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + 4.15 + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + iopswriterate + io requests write rate of the disk offering + false + 4.15 + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + 4.15 + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + name + updates name of the disk offering with this value + false + string + + + sortkey + sort key of the disk offering, integer + false + integer + + + state + state of the disk offering + false + string + + + tags + comma-separated list of tags for the disk offering, tags should match with existing storage pool tags + false + 4.15 + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + state + state of the disk offering + string + + + storagetype + the storage type for this disk offering + string + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + removeVirtualMachinesFromKubernetesCluster + Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters. + false + 4.19.0 + + + id + the ID of the Kubernetes cluster + true + uuid + + + virtualmachineids + the IDs of the VMs to remove from the cluster + true + list + list + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the Kubernetes cluster + string + + + false + + + deleteTungstenFabricLogicalRouter + delete Tungsten-Fabric logical router + true + + + logicalrouteruuid + the uuid of Tungsten-Fabric logical router + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + resetVpnConnection + Reset site to site vpn connection + true + + + id + id of vpn connection + true + uuid + + + account + an optional account for connection. Must be used with domainId. + false + string + + + domainid + an optional domainId for connection. If the account parameter is used, domainId must also be used. + false + uuid + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + listKubernetesClusters + Lists Kubernetes clusters + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged + false + 4.19.0 + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the Kubernetes cluster + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned) + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + state of the Kubernetes cluster + false + string + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + createAutoScaleVmGroup + Creates and automatically starts a virtual machine based on a service offering, disk offering, and template. + true + + + lbruleid + the ID of the load balancer rule + true + uuid + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + true + integer + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + true + integer + + + scaledownpolicyids + list of scaledown autoscale policies + true + list + list + + + scaleuppolicyids + list of scaleup autoscale policies + true + list + list + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + true + uuid + + + fordisplay + an optional field, whether to the display the group to the end user or not + false + 4.4 + boolean + + + interval + the frequency in which the performance counters to be collected + false + integer + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + addBaremetalPxePingServer + add a baremetal ping pxe server + true + + + password + Credentials to reach external pxe device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + pingdir + Root directory on PING storage server + true + string + + + pingstorageserverip + PING storage server ip + true + string + + + pxeservertype + type of pxe device + true + string + + + tftpdir + Tftp root directory of PXE server + true + string + + + url + URL of the external pxe device + true + string + + + username + Credentials to reach external pxe device + true + string + + + pingcifspassword + Password of PING storage server + false + string + + + pingcifsusername + Username of PING storage server + false + string + + + podid + Pod Id + false + uuid + + + + + pingdir + Root directory on PING storage server + string + + + pingstorageserverip + PING storage server ip + string + + + tftpdir + Tftp root directory of PXE server + string + + + false + + + deleteLoadBalancerRule + Deletes a load balancer rule. + true + + + id + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listPortableIpRanges + list portable IP ranges + false + + + id + Id of the portable ip range + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + regionid + Id of a Region + false + integer + + + + + id + portable IP range ID + string + + + endip + the end ip of the portable IP range + string + + + gateway + the gateway of the VLAN IP range + string + + + netmask + the netmask of the VLAN IP range + string + + + regionid + Region Id in which portable ip range is provisioned + integer + + + startip + the start ip of the portable IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + portableipaddress(*) + List of portable IP and association with zone/network/vpc details that are part of GSLB rule + + + accountid + the account ID the portable IP address is associated with + string + + + allocated + date the portal IP address was acquired + date + + + domainid + the domain ID the portable IP address is associated with + string + + + ipaddress + public IP address + string + + + networkid + the ID of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + regionid + Region Id in which global load balancer is created + integer + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing and Free + string + + + vpcid + VPC the ip belongs to + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + list + + + false + + + getVirtualMachineUserData + Returns user data associated with the VM + false + 4.4 + + + virtualmachineid + The ID of the virtual machine + true + uuid + + + + + userdata + Base64 encoded VM user data + string + + + virtualmachineid + the ID of the virtual machine + string + + + false + + + createNetworkPermissions + Updates network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + accountids + a comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + accounts + a comma delimited list of accounts within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + projectids + a comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaTariffUpdate + Update the tariff plan for a resource + false + 4.7.0 + + + name + Quota tariff's name + true + 4.18.0.0 + string + + + activationrule + Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule. + false + 4.18.0.0 + string + + + description + Quota tariff's description. Inform empty to remove the description. + false + 4.18.0.0 + string + + + enddate + The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2009-06-03. + false + 4.18.0.0 + date + + + startdate + DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + usagetype + DEPRECATED. Integer value for the usage type of the resource + false + integer + + + value + The quota tariff value of the resource as per the default unit. + false + double + + + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + uuid + uuid + string + + + false + + + addIpToNic + Assigns secondary IP to NIC + true + + + nicid + the ID of the nic to which you want to assign private IP + true + uuid + + + ipaddress + Secondary IP Address + false + string + + + + + id + the ID of the secondary private IP addr + string + + + ipaddress + Secondary IP address + string + + + networkid + the ID of the network + string + + + nicid + the ID of the nic + string + + + secondaryip + the list of Secondary ipv4 addr of nic + list + + + virtualmachineid + the ID of the vm + string + + + false + + + disableStaticNat + Disables static rule for given IP address + true + + + ipaddressid + the public IP address ID for which static NAT feature is being disabled + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteUcsManager + Delete a Ucs manager + false + + + ucsmanagerid + ucs manager id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteHost + Deletes a host. + false + + + id + the host ID + true + uuid + + + forced + Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped + false + boolean + + + forcedestroylocalstorage + Force destroy local storage on this host. All VMs created on this local storage will be destroyed + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteResourceIcon + deletes the resource icon from the specified resource(s) + false + 4.16.0.0 + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listCapabilities + Lists capabilities + false + + + + allowusercreateprojects + true if regular user is allowed to create projects + boolean + + + allowuserexpungerecovervm + true if the user can recover and expunge virtualmachines, false otherwise + 4.6.0 + boolean + + + allowuserexpungerecovervolume + true if the user can recover and expunge volumes, false otherwise + 4.14.0 + boolean + + + allowuserviewalldomainaccounts + true if users can see all accounts within the same domain, false otherwise + boolean + + + allowuserviewdestroyedvm + true if the user is allowed to view destroyed virtualmachines, false otherwise + 4.6.0 + boolean + + + apilimitinterval + time interval (in seconds) to reset api count + integer + + + apilimitmax + Max allowed number of api requests within the specified interval + integer + + + cloudstackversion + version of the cloud stack + string + + + customdiskofferingmaxsize + maximum size that can be specified when create disk from disk offering with custom size + long + + + customdiskofferingminsize + minimum size that can be specified when create disk from disk offering with custom size + long + + + customhypervisordisplayname + Display name for custom hypervisor + 4.19.0 + string + + + defaultuipagesize + default page size in the UI for various views, value set in the configurations + 4.15.2 + long + + + dynamicrolesenabled + true if dynamic role-based api checker is enabled, false otherwise + boolean + + + instancesdisksstatsretentionenabled + true if stats are retained for instance disks otherwise false + 4.18.0 + boolean + + + instancesdisksstatsretentiontime + the retention time for Instances disks stats + 4.18.0 + integer + + + instancesstatsretentiontime + the retention time for Instances stats + 4.18.0 + integer + + + instancesstatsuseronly + true if stats are collected only for user instances, false if system instance stats are also collected + 4.18.0 + boolean + + + kubernetesclusterexperimentalfeaturesenabled + true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise + boolean + + + kubernetesserviceenabled + true if Kubernetes Service plugin is enabled, false otherwise + boolean + + + kvmsnapshotenabled + true if snapshot is supported for KVM host, false otherwise + boolean + + + projectinviterequired + If invitation confirmation is required when add account to project + boolean + + + regionsecondaryenabled + true if region wide secondary is enabled, false otherwise + boolean + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + supportELB + true if region supports elastic load balancer on basic zones + string + + + userpublictemplateenabled + true if user and domain admins can set templates to be shared, false otherwise + boolean + + + false + + + releaseDedicatedZone + Release dedication of zone + true + + + zoneid + the ID of the Zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + checkVolume + Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only + true + 4.19.1 + + + id + The ID of the volume + true + uuid + + + repair + parameter to repair the volume, leaks or all are the possible values + false + string + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateNetworkServiceProvider + Updates a network serviceProvider of a physical network + true + 3.0.0 + + + id + network service provider id + true + uuid + + + servicelist + the list of services to be enabled for this physical network service provider + false + list + list + + + state + Enabled/Disabled/Shutdown the physical network service provider + false + string + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + listManagementServersMetrics + Lists Management Server metrics + false + 4.17.0 + + + id + the id of the management server + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the management server + false + string + + + page + false + integer + + + pagesize + false + integer + + + system + include system level stats + false + boolean + + + + + agentcount + the number of agents this Management Server is responsible for + integer + + + availableprocessors + the number of processors available to the JVM + integer + + + collectiontime + the time these statistics were collected + date + + + cpuload + the current cpu load + string + + + dbislocal + the system is running against a local database + boolean + + + heapmemorytotal + the amount of memory allocated to this Management Server + long + + + heapmemoryused + the amount of memory used by this Management Server + long + + + loginfo + the log files and their usage on disk + string + + + sessions + the number of client sessions active on this Management Server + long + + + systemcycleusage + the system load for user, and system processes and the system idle cycles + long[] + + + systemloadaverages + the load averages for 1 5 and 15 minutes + double[] + + + systemmemoryfree + Free system memory + string + + + systemmemorytotal + Total system memory + string + + + systemmemoryused + Amount of memory used + string + + + systemmemoryvirtualsize + Virtual size of the fully loaded process + string + + + systemtotalcpucycles + the total system cpu capacity + double + + + threadsblockedcount + The number of blocked threads + integer + + + threadsdaemoncount + The number of daemon threads + integer + + + threadsrunnablecount + The number of runnable threads + integer + + + threadsteminatedcount + The number of terminated threads + integer + + + threadstotalcount + The number of threads + integer + + + threadswaitingcount + The number of waiting threads + integer + + + usageislocal + the system has a usage server running locally + boolean + + + false + + + removeFromLoadBalancerRule + Removes a virtual machine or a list of virtual machines from a load balancer rule. + true + + + id + The ID of the load balancer rule + true + uuid + + + virtualmachineids + the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3) + false + list + list + + + vmidipmap + VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75 + false + map + 4.4 + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listInstanceGroups + Lists vm groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list instance groups by ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list instance groups by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + domainpath + path of the Domain the instance group belongs to + 4.19.2.0 + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + createStaticRoute + Creates a static route + true + + + cidr + static route cidr + true + string + + + gatewayid + the gateway id we are creating static route for + true + uuid + + + + + id + the ID of static route + string + + + account + the account associated with the static route + string + + + cidr + static route CIDR + string + + + domain + the domain associated with the static route + string + + + domainid + the ID of the domain associated with the static route + string + + + domainpath + the domain path associated with the static route + 4.19.2.0 + string + + + gatewayid + VPC gateway the route is created for + string + + + project + the project name of the static route + string + + + projectid + the project id of the static route + string + + + state + the state of the static route + string + + + vpcid + VPC the static route belongs to + string + + + tags(*) + the list of resource tags associated with static route + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deletePrivateGateway + Deletes a Private gateway + true + + + id + the ID of the private gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateDomain + Updates a domain with a new name + false + + + id + ID of domain to update + true + uuid + + + name + updates domain with this name + false + string + + + networkdomain + Network domain for the domain's networks; empty string will update domainName with NULL value + false + string + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + disableAutoScaleVmGroup + Disables an AutoScale Vm Group + true + + + id + the ID of the autoscale group + true + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + createSnapshotPolicy + Creates a snapshot policy for the account. + false + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + maxsnaps + maximum number of snapshots to retain + true + integer + + + schedule + time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + true + string + + + volumeid + the ID of the disk volume + true + uuid + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + tags + Map of tags (key/value pairs) + false + map + map + + + zoneids + A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present. + false + list + list + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + zone + The list of zones in which snapshot backup is scheduled + 4.19.0 + set + + + false + + + disableHAForZone + Disables HA for a zone + true + 4.11 + + + zoneid + ID of the zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + unmanageVolume + Unmanage a volume on storage pool. + true + 4.19.1 + + + id + The ID of the volume to unmanage + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSystemVms + List system virtual machines. + false + + + hostid + the host ID of the system VM + false + uuid + + + id + the ID of the system VM + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the system VM + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the system VM + false + uuid + + + state + the state of the system VM + false + string + + + storageid + the storage ID where vm's volumes belong to + false + 3.0.1 + uuid + + + systemvmtype + the system VM type. Possible types are "consoleproxy" and "secondarystoragevm". + false + string + + + zoneid + the Zone ID of the system VM + false + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + createRolePermission + Adds an API permission to a role + false + 4.9.0 + + + permission + The rule permission, allow or deny. Default: deny. + true + string + + + roleid + ID of the role + true + uuid + + + rule + The API name or wildcard rule such as list* + true + string + + + description + The description of the role permission + false + string + + + + + id + the ID of the role permission + string + + + roleid + the ID of the role to which the role permission belongs + string + + + rolename + the name of the role to which the role permission belongs + string + + + false + + + replaceNetworkACLList + Replaces ACL associated with a network or private gateway + true + + + aclid + the ID of the network ACL + true + uuid + + + gatewayid + the ID of the private gateway + false + uuid + + + networkid + the ID of the network + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + detachVolume + Detaches a disk volume from a virtual machine. + true + + + deviceid + the device ID on the virtual machine where volume is detached from + false + long + + + id + the ID of the disk volume + false + uuid + + + virtualmachineid + the ID of the virtual machine where the volume is detached from + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTungstenFabricAddressGroup + list Tungsten-Fabric address group + false + + + addressgroupuuid + the uuid of Tungsten-Fabric address group + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + ipprefix + Tungsten-Fabric address group ip prefix + string + + + ipprefixlen + Tungsten-Fabric address group ip prefix length + int + + + name + Tungsten-Fabric address group name + string + + + uuid + Tungsten-Fabric address group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + enableOutOfBandManagementForZone + Enables out-of-band management for a zone + true + 4.9.0 + + + zoneid + the ID of the zone + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listLdapUsers + Lists LDAP Users according to the specifications from the user request. + false + 4.2.0 + + + domainid + linked domain + false + uuid + + + keyword + List by keyword + false + string + + + listtype + Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter + false + string + + + page + false + integer + + + pagesize + false + integer + + + userfilter + Determines what type of filter is applied on the list of users returned from LDAP. + valid values are + 'NoFilter' no filtering is done, + 'LocalDomain' users already in the current or requested domain will be filtered out of the result list, + 'AnyDomain' users that already exist anywhere in cloudstack will be filtered out, and + 'PotentialImport' all users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource + false + 4.13 + string + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + createVMSchedule + Create VM Schedule + false + 4.19.0 + + + action + Action to take on the VM (start/stop/restart/force_stop/force_reboot). + true + string + + + schedule + Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month' + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + description + Description of the schedule + false + string + + + enabled + Enable VM schedule. Defaults to true + false + boolean + + + enddate + end date after which the schedule becomes inactiveUse format "yyyy-MM-dd hh:mm:ss") + false + date + + + startdate + start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of VM schedule + string + + + action + Action + action + + + created + Date when the schedule was created + date + + + description + Description of VM schedule + string + + + enabled + VM schedule is enabled + boolean + + + enddate + Date after which the schedule becomes inactive + date + + + schedule + Cron formatted VM schedule + string + + + startdate + Date from which the schedule is active + date + + + timezone + Timezone of the schedule + string + + + virtualmachineid + ID of virtual machine + string + + + false + + + listIpForwardingRules + List the IP forwarding rules + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + list the rule belonging to this public IP address + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + virtualmachineid + Lists all rules applied to the specified VM. + false + uuid + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createSnapshot + Creates an instant snapshot of a volume. + true + + + volumeid + The ID of the disk volume + true + uuid + + + account + The account of the snapshot. The account parameter must be used with the domainId parameter. + false + string + + + asyncbackup + asynchronous backup if true + false + boolean + + + domainid + The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain. + false + uuid + + + locationtype + Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'. + false + string + + + name + the name of the snapshot + false + string + + + policyid + policy id of the snapshot, if this is null, then use MANUAL_POLICY. + false + uuid + + + quiescevm + quiesce vm if true + false + boolean + + + tags + Map of tags (key/value pairs) + false + map + map + + + zoneids + A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. + false + list + 4.19.0 + list + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listStoragePoolsMetrics + Lists storage pool metrics + false + 4.9.3 + + + clusterid + list storage pools belongig to the specific cluster + false + uuid + + + hostid + host ID of the storage pools + false + uuid + + + id + the ID of the storage pool + false + uuid + + + ipaddress + the IP address for the storage pool + false + string + + + keyword + List by keyword + false + string + + + name + the name of the storage pool + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the storage pool path + false + string + + + podid + the Pod ID for the storage pool + false + uuid + + + scope + the scope of the storage pool + false + string + + + status + the status of the storage pool + false + string + + + storagecustomstats + If true, lists the custom stats of the storage pool + false + 4.18.1 + boolean + + + zoneid + the Zone ID for the storage pool + false + uuid + + + + + disksizeallocatedgb + disk size allocated in GiB + string + + + disksizetotalgb + disk size in GiB + string + + + disksizeunallocatedgb + disk size unallocated in GiB + string + + + disksizeusedgb + disk size used in GiB + string + + + storageallocateddisablethreshold + storage allocated disable threshold exceeded + boolean + + + storageallocatedthreshold + storage allocated notification threshold exceeded + boolean + + + storageusagedisablethreshold + storage usage disable threshold exceeded + boolean + + + storageusagethreshold + storage usage notification threshold exceeded + boolean + + + false + + + deleteBackupOffering + Deletes a backup offering + false + 4.14.0 + + + id + ID of the backup offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createSSHKeyPair + Create a new keypair and returns the private key + false + + + name + Name of the keypair + true + string + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the ssh key. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the ssh key + false + uuid + + + + + privatekey + Private key + string + + + false + + + listTungstenFabricServiceGroup + list Tungsten-Fabric service group + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + servicegroupuuid + the uuid of Tungsten-Fabric service group + false + string + + + zoneid + the ID of zone + false + uuid + + + + + endport + Tungsten-Fabric service group end port + int + + + name + Tungsten-Fabric service group name + string + + + protocol + Tungsten-Fabric service group protocol + string + + + startport + Tungsten-Fabric service group start port + int + + + uuid + Tungsten-Fabric service group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + authorizeSecurityGroupEgress + Authorizes a particular egress rule for this security group + true + 3.0.0 + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + cidrlist + the cidr list associated. Multiple entries must be separated by a single comma character (,). + false + list + list + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + endport + end port for this egress rule + false + integer + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + projectid + an optional project of the security group + false + uuid + + + protocol + TCP is default. UDP is the other supported protocol + false + string + + + securitygroupid + The ID of the security group. Mutually exclusive with securityGroupName parameter + false + uuid + + + securitygroupname + The name of the security group. Mutually exclusive with securityGroupId parameter + false + string + + + startport + start port for this egress rule + false + integer + + + usersecuritygrouplist + user to security group mapping + false + map + map + + + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listStoragePools + Lists storage pools. + false + + + clusterid + list storage pools belongig to the specific cluster + false + uuid + + + hostid + host ID of the storage pools + false + uuid + + + id + the ID of the storage pool + false + uuid + + + ipaddress + the IP address for the storage pool + false + string + + + keyword + List by keyword + false + string + + + name + the name of the storage pool + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the storage pool path + false + string + + + podid + the Pod ID for the storage pool + false + uuid + + + scope + the scope of the storage pool + false + string + + + status + the status of the storage pool + false + string + + + storagecustomstats + If true, lists the custom stats of the storage pool + false + 4.18.1 + boolean + + + zoneid + the Zone ID for the storage pool + false + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + enableCiscoNexusVSM + Enable a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be enabled + true + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + findHostsForMigration + Find hosts suitable for migrating a virtual machine. + false + + + virtualmachineid + find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + requiresStorageMotion + true if migrating a vm to this host requires storage motion, false otherwise + boolean + + + false + + + updateHypervisorCapabilities + Updates a hypervisor capabilities. + false + 3.0.0 + + + hypervisor + the hypervisor for which the hypervisor capabilities are to be updated + false + 4.19.1 + string + + + hypervisorversion + the hypervisor version for which the hypervisor capabilities are to be updated + false + 4.19.1 + string + + + id + ID of the hypervisor capability + false + uuid + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached to a VM for this hypervisor. + false + 4.16.0 + integer + + + maxguestslimit + the max number of Guest VMs per host for this hypervisor. + false + long + + + maxhostspercluster + the maximum number of the hypervisor hosts per cluster + false + 4.16.0 + integer + + + securitygroupenabled + set true to enable security group for this hypervisor. + false + boolean + + + storagemotionenabled + set true to enable storage motion support for this hypervisor + false + 4.16.0 + boolean + + + vmsnapshotenabled + set true to enable VM snapshots for this hypervisor + false + 4.16.0 + boolean + + + + + id + the ID of the hypervisor capabilities row + string + + + hypervisor + the hypervisor type + string + + + hypervisorversion + the hypervisor version + string + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached for this hypervisor + integer + + + maxguestslimit + the maximum number of guest vms recommended for this hypervisor + long + + + maxhostspercluster + the maximum number of Hosts per cluster for this hypervisor + integer + + + securitygroupenabled + true if security group is supported + boolean + + + storagemotionenabled + true if storage motion is supported + boolean + + + vmsnapshotenabled + true if VM snapshots are enabled for this hypervisor + boolean + + + false + + + isAccountAllowedToCreateOfferingsWithTags + Return true if the specified account is allowed to create offerings with tags. + false + + + id + Account UUID + false + uuid + + + + + isallowed + is domain admin allowed to create offerings with tags + boolean + + + false + + + addNicToVirtualMachine + Adds VM to specified network by creating a NIC + true + + + networkid + Network ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + dhcpoptions + DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com + false + map + map + + + ipaddress + IP Address for the new network + false + string + + + macaddress + Mac Address for the new network + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + getSPMetadata + Returns SAML2 CloudStack Service Provider MetaData + false + + + + metadata + The Metadata XML + string + + + false + + + listStaticRoutes + Lists all static routes + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + gatewayid + list static routes by gateway id + false + uuid + + + id + list static route by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + list static routes by state + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vpcid + list static routes by vpc id + false + uuid + + + + + id + the ID of static route + string + + + account + the account associated with the static route + string + + + cidr + static route CIDR + string + + + domain + the domain associated with the static route + string + + + domainid + the ID of the domain associated with the static route + string + + + domainpath + the domain path associated with the static route + 4.19.2.0 + string + + + gatewayid + VPC gateway the route is created for + string + + + project + the project name of the static route + string + + + projectid + the project id of the static route + string + + + state + the state of the static route + string + + + vpcid + VPC the static route belongs to + string + + + tags(*) + the list of resource tags associated with static route + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listPublicIpAddresses + Lists all public ip addresses + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + allocatedonly + limits search results to allocated public IP addresses + false + boolean + + + associatednetworkid + lists all public IP addresses associated to the network specified + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + forloadbalancing + list only IPs used for load balancing + false + boolean + + + forvirtualnetwork + the virtual network for the IP address + false + boolean + + + id + lists IP address by ID + false + uuid + + + ipaddress + lists the specified IP address + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issourcenat + list only source NAT IP addresses + false + boolean + + + isstaticnat + list only static NAT IP addresses + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + lists all public IP addresses by source network ID + false + 4.13.0 + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + lists all public IP addresses by physical network ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + state + lists all public IP addresses by state + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vlanid + lists all public IP addresses by VLAN ID + false + uuid + + + vpcid + List IPs belonging to the VPC + false + uuid + + + zoneid + lists all public IP addresses by zone ID + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listOpenDaylightControllers + Lists OpenDyalight controllers + false + + + id + the ID of a OpenDaylight Controller + false + uuid + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + addBigSwitchBcfDevice + Adds a BigSwitch BCF Controller device + true + 4.6.0 + + + hostname + Hostname of ip address of the BigSwitch BCF Controller. + true + string + + + nat + NAT support of the BigSwitch BCF Controller. + true + boolean + + + password + Password of the BigSwitch BCF Controller. + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Username of the BigSwitch BCF Controller. + true + string + + + + + bcfdeviceid + device id of the BigSwitch BCF Controller + string + + + bigswitchdevicename + device name + string + + + hostname + the controller Ip address + string + + + nat + NAT support + boolean + + + password + the controller password + string + + + physicalnetworkid + the physical network to which this BigSwitch BCF segment belongs to + string + + + provider + name of the provider + string + + + username + the controller username + string + + + false + + + updateDefaultNicForVirtualMachine + Changes the default NIC on a VM + true + + + nicid + NIC ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + generateClusterDrsPlan + Generate DRS plan for a cluster + false + 4.19.0 + + + id + the ID of the Cluster + true + uuid + + + migrations + Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting + false + integer + + + + + id + unique ID of the drs plan for cluster + string + + + clusterid + Id of the cluster + string + + + eventid + Start event Id of the DRS Plan + string + + + migrations + List of migrations + list + + + status + Status of DRS Plan + status + + + type + Type of DRS Plan (Automated or Manual)) + type + + + false + + + issueOutOfBandManagementPowerAction + Initiates the specified power action to the host's out-of-band management interface + true + 4.9.0 + + + action + out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS + true + string + + + hostid + the ID of the host + true + uuid + + + timeout + optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting + false + long + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + deleteUser + Deletes a user for an account + false + + + id + id of the user to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkDevice + Deletes network device. + false + + + id + Id of network device to delete + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateImageStore + Updates image store read-only status + false + 4.15.0 + + + id + Image Store UUID + true + uuid + + + capacitybytes + The number of bytes CloudStack can use on this image storage. + NOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage. + false + long + + + name + The new name for the Image Store. + false + string + + + readonly + If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration + false + boolean + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + assignToLoadBalancerRule + Assigns virtual machine or a list of virtual machines to a load balancer rule. + true + + + id + the ID of the load balancer rule + true + uuid + + + virtualmachineids + the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3) + false + list + list + + + vmidipmap + VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75 + false + map + 4.4 + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAsyncJobs + Lists all pending asynchronous jobs for the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + managementserverid + The id of the management server + false + 4.19 + uuid + + + page + false + integer + + + pagesize + false + integer + + + startdate + The start date of the async job (use format "yyyy-MM-dd'T'HH:mm:ss'+'SSSS") + false + date + + + + + account + the account that executed the async command + string + + + accountid + the account id that executed the async command + string + + + cmd + the async command executed + string + + + completed + the completed date of the job + date + + + created + the created date of the job + date + + + domainid + the domain id that executed the async command + string + + + domainpath + the domain that executed the async command + string + + + jobinstanceid + the unique ID of the instance/entity object related to the job + string + + + jobinstancetype + the instance/entity object related to the job + string + + + jobprocstatus + the progress information of the PENDING job + integer + + + jobresult + the result reason + responseobject + + + jobresultcode + the result code for the job + integer + + + jobresulttype + the result type + string + + + jobstatus + the current job status-should be 0 for PENDING + integer + + + managementserverid + the msid of the management server on which the job is running + 4.19 + long + + + userid + the user that executed the async command + string + + + jobid + the ID of the async job + + + false + + + archiveAlerts + Archive one or more alerts. + false + + + enddate + end date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the alerts + false + list + list + + + startdate + start date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + archive by alert type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteCiscoVnmcResource + Deletes a Cisco Vnmc controller + false + + + resourceid + Cisco Vnmc resource ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createSecondaryStorageSelector + Creates a secondary storage selector, described by the heuristic rule. + false + 4.19.0 + + + description + The description of the heuristic rule. + true + string + + + heuristicrule + The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID. + true + string + + + name + The name identifying the heuristic rule. + true + string + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + true + string + + + zoneid + The zone in which the heuristic rule will be applied. + true + uuid + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + addBrocadeVcsDevice + Adds a Brocade VCS Switch + true + + + hostname + Hostname of ip address of the Brocade VCS Switch. + true + string + + + password + Credentials to access the Brocade VCS Switch API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Credentials to access the Brocade VCS Switch API + true + string + + + + + brocadedevicename + device name + string + + + hostname + the principal switch Ip address + string + + + physicalnetworkid + the physical Network to which this Brocade VCS belongs to + string + + + provider + name of the provider + string + + + vcsdeviceid + device id of the Brocade Vcs + string + + + false + + + deleteTags + Deleting resource tag(s) + true + 4.0.0 + + + resourceids + Delete tags for resource id(s) + true + list + list + + + resourcetype + Delete tag by resource type + true + string + + + tags + Delete tags matching key/value pairs + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricTagType + create Tungsten-Fabric tag type + true + + + name + Tungsten-Fabric tag type name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric tag type name + string + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + login + Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired. + false + + + password + Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Username + true + string + + + domain + Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed. + false + string + + + domainId + The id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precedence. + false + long + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + restartNetwork + Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules + true + + + id + The ID of the network to restart. + true + uuid + + + cleanup + If cleanup old network elements + false + boolean + + + livepatch + Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false. + false + 4.17.0 + boolean + + + makeredundant + Turn the network into a network with redundant routers. + false + 4.11.1 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listHypervisorCapabilities + Lists all hypervisor capabilities. + false + 3.0.0 + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + ID of the hypervisor capability + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the hypervisor capabilities row + string + + + hypervisor + the hypervisor type + string + + + hypervisorversion + the hypervisor version + string + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached for this hypervisor + integer + + + maxguestslimit + the maximum number of guest vms recommended for this hypervisor + long + + + maxhostspercluster + the maximum number of Hosts per cluster for this hypervisor + integer + + + securitygroupenabled + true if security group is supported + boolean + + + storagemotionenabled + true if storage motion is supported + boolean + + + vmsnapshotenabled + true if VM snapshots are enabled for this hypervisor + boolean + + + false + + + deleteProjectRole + Delete Project roles in CloudStack + false + 4.15.0 + + + id + ID of the project role to be deleted + true + uuid + + + projectid + ID of the project from where the role is to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaBalance + Create a quota balance statement + false + 4.7.0 + + + account + Account Id for which statement needs to be generated + true + string + + + domainid + If domain Id is given and the caller is domain admin then the statement is generated for domain. + true + uuid + + + accountid + List usage records for the specified account + false + uuid + + + enddate + End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + startdate + Start date range quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + false + date + + + + + account + account name + string + + + accountid + account id + long + + + domain + domain id + long + + + name + usage type name + string + + + quota + quota consumed + bigdecimal + + + type + usage type + int + + + unit + usage unit + string + + + false + + + getSolidFireAccountId + Get SolidFire Account ID + false + + + accountid + CloudStack Account UUID + true + string + + + storageid + Storage Pool UUID + true + string + + + + + solidFireAccountId + SolidFire Account ID + long + + + false + + + listRolePermissions + Lists role permissions + false + 4.9.0 + + + roleid + ID of the role + false + uuid + + + + + id + the ID of the role permission + string + + + roleid + the ID of the role to which the role permission belongs + string + + + rolename + the name of the role to which the role permission belongs + string + + + false + + + listDedicatedGuestVlanRanges + Lists dedicated guest vlan ranges + false + + + account + the account with which the guest VLAN range is associated. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain. + false + uuid + + + guestvlanrange + the dedicated guest vlan range + false + string + + + id + list dedicated guest vlan ranges by id + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + physical network id of the guest VLAN range + false + uuid + + + projectid + project who will own the guest VLAN range + false + uuid + + + zoneid + zone of the guest VLAN range + false + uuid + + + + + id + the ID of the guest VLAN range + string + + + account + the account of the guest VLAN range + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + domainpath + path of the domain to which the guest VLAN range belongs + 4.19.2.0 + string + + + guestvlanrange + the guest VLAN range + string + + + physicalnetworkid + the physical network of the guest vlan range + long + + + project + the project name of the guest vlan range + string + + + projectid + the project id of the guest vlan range + string + + + zoneid + the zone of the guest vlan range + long + + + false + + + listNetworkACLs + Lists all network ACL items + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + aclid + list network ACL items by ACL ID + false + uuid + + + action + list network ACL items by action + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists network ACL Item with the specified ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list network ACL items by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + protocol + list network ACL items by protocol + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + list network ACL items by traffic type - ingress or egress + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + copyTemplate + Copies a template from one zone to another. + true + + + id + Template ID. + true + uuid + + + destzoneid + ID of the zone the template is being copied to. + false + uuid + + + destzoneids + 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. + false + list + list + + + sourcezoneid + 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. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listNiciraNvpDeviceNetworks + lists network that are using a nicira nvp device + false + + + nvpdeviceid + nicira nvp device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteBigSwitchBcfDevice + delete a BigSwitch BCF Controller device + true + 4.6.0 + + + bcfdeviceid + BigSwitch device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listOvsElements + Lists all available ovs elements. + false + + + enabled + list network offerings by enabled state + false + boolean + + + id + list ovs elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list ovs elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the ovs + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + associateUcsProfileToBlade + associate a profile to a blade + true + + + bladeid + blade id + true + uuid + + + profiledn + profile dn + true + string + + + ucsmanagerid + ucs manager id + true + uuid + + + + + id + ucs blade id + string + + + bladedn + ucs blade dn + string + + + hostid + cloudstack host id this blade associates to + string + + + profiledn + associated ucs profile dn + string + + + ucsmanagerid + ucs manager id + string + + + false + + + validateUserTwoFactorAuthenticationCode + Checks the 2FA code for the user. + false + 4.18.0 + + + codefor2fa + two factor authentication code + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateVmwareDc + Updates a VMware datacenter details for a zone + false + 4.12.0 + + + zoneid + The zone ID + true + uuid + + + isrecursive + Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true. + false + boolean + + + name + VMware datacenter name. + false + string + + + password + The password for specified username. + false + string + + + username + The username required to connect to resource. + false + string + + + vcenter + The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + listNetscalerControlCenter + list control center + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + id + string + + + ipaddress + ncc_ip + string + + + numretries + num_retries + string + + + username + username + string + + + uuid + uuid + string + + + false + + + getRouterHealthCheckResults + Starts a router. + false + 4.14.0 + + + routerid + the ID of the router + true + uuid + + + performfreshchecks + if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched + false + boolean + + + + + healthchecks + the id of the router + list + + + routerid + the id of the router + string + + + false + + + deleteAffinityGroup + Deletes affinity group + true + + + account + the account of the affinity group. Must be specified with domain ID + false + string + + + domainid + the domain ID of account owning the affinity group + false + uuid + + + id + The ID of the affinity group. Mutually exclusive with name parameter + false + uuid + + + name + The name of the affinity group. Mutually exclusive with ID parameter + false + string + + + projectid + the project of the affinity group + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + resizeVolume + Resizes a volume + true + + + id + the ID of the disk volume + true + uuid + + + diskofferingid + new disk offering id + false + uuid + + + maxiops + New maximum number of IOPS + false + long + + + miniops + New minimum number of IOPS + false + long + + + shrinkok + Verify OK to Shrink + false + boolean + + + size + New volume size in GB + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteNetworkOffering + Deletes a network offering. + false + 3.0.0 + + + id + the ID of the network offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + dedicatePod + Dedicates a Pod. + true + + + domainid + the ID of the containing domain + true + uuid + + + podid + the ID of the Pod + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Pod is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the pod + string + + + domainid + the domain ID to which the Pod is dedicated + string + + + podid + the ID of the Pod + string + + + podname + the Name of the Pod + string + + + false + + + updateStorageNetworkIpRange + Update a Storage network IP range, only allowed when no IPs in this range have been allocated. + true + 3.0.0 + + + id + UUID of storage network ip range + true + uuid + + + endip + the ending IP address + false + string + + + netmask + the netmask for storage network + false + string + + + startip + the beginning IP address + false + string + + + vlan + Optional. the vlan the ip range sits on + false + integer + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + synchronizeTungstenFabricData + Synchronize Tungsten-Fabric data + false + + + id + provider id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + changeOfferingForVolume + Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering + true + 4.17 + + + id + the ID of the volume + true + uuid + + + diskofferingid + new disk offering id + true + uuid + + + automigrate + Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering + false + boolean + + + maxiops + New maximum number of IOPS for the custom disk offering + false + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + long + + + shrinkok + Verify OK to Shrink + false + boolean + + + size + New volume size in GB for the custom disk offering + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteLdapConfiguration + Remove an Ldap Configuration + false + 4.2.0 + + + hostname + Hostname + true + string + + + domainid + linked domain + false + uuid + + + port + port + false + integer + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port the ldap server is running on + int + + + false + + + createProjectRole + Creates a Project role + false + 4.15.0 + + + name + creates a project role with this unique name + true + string + + + projectid + ID of project where role is being created + true + uuid + + + description + The description of the Project role + false + string + + + + + projectid + the id of the project + string + + + false + + + createIpv6FirewallRule + Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC) + true + + + networkid + The network of the VM the Ipv6 firewall rule will be created for + true + uuid + + + protocol + the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + true + string + + + cidrlist + the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + destcidrlist + the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of Ipv6 firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + startport + the starting port of Ipv6 firewall rule + false + integer + + + traffictype + the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + triggerShutdown + Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced + false + 4.19.0 + + + managementserverid + the uuid of the management server + true + uuid + + + + + managementserverid + The id of the management server + string + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + updateNetwork + Updates a network + true + + + id + the ID of the network + true + uuid + + + changecidr + Force update even if CIDR type is different + false + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + false + boolean + + + displaytext + the new display text for the network + false + string + + + dns1 + the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone + false + 4.18.0 + string + + + forced + Setting this to true will cause a forced network update, + false + boolean + + + guestvmcidr + CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR + false + string + + + hideipaddressusage + when true ip address usage for the network will not be exported by the listUsageRecords API + false + boolean + + + ip6dns1 + the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone + false + 4.18.0 + string + + + name + the new name for the network + false + string + + + networkdomain + network domain + false + string + + + networkofferingid + network offering ID + false + uuid + + + privatemtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network + false + 4.19 + string + + + updateinsequence + if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider + false + boolean + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listBackups + Lists VM backups + false + 4.14.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + id of the backup + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + virtualmachineid + id of the VM + false + uuid + + + zoneid + list backups by zone id + false + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + date + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + listUsageTypes + List Usage Types + false + + + + description + description of usage type + string + + + usagetypeid + usage type + integer + + + false + + + listBackupProviders + Lists Backup and Recovery providers + false + 4.14.0 + + + name + List Backup and Recovery provider by name + false + string + + + + + description + the description of the CA service provider + string + + + name + the CA service provider name + string + + + false + + + deleteVPC + Deletes a VPC + true + + + id + the ID of the VPC + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateVirtualMachine + Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default + false + 4.16.0 + boolean + + + hostid + Destination Host ID to migrate VM to. + false + uuid + + + storageid + Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteKubernetesSupportedVersion + Deletes a Kubernetes cluster + true + + + id + the ID of the Kubernetes supported version + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBaremetalRct + list baremetal rack configuration + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + id of rct + string + + + url + url + string + + + false + + + listCAProviders + Lists available certificate authority providers in CloudStack + false + 4.11.0 + + + name + List CA service provider by name + false + string + + + + + description + the description of the CA service provider + string + + + name + the CA service provider name + string + + + false + + + deleteVpnCustomerGateway + Delete site to site vpn customer gateway + true + + + id + id of customer gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + acquirePodIpAddress + Allocates IP addresses in respective Pod of a Zone + false + + + zoneid + the ID of the zone + true + string + + + podid + Pod ID + false + string + + + + + id + the ID of the pod the IP address + long + + + cidr + CIDR of the Pod + string + + + gateway + Gateway for Pod + string + + + hostmac + MAC address of the pod the IP + long + + + ipaddress + Allocated IP address + string + + + nicid + the ID of the nic + long + + + podid + the ID of the pod the IP address belongs to + long + + + false + + + enableOutOfBandManagementForCluster + Enables out-of-band management for a cluster + true + 4.9.0 + + + clusterid + the ID of the cluster + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listPortForwardingRules + Lists all port forwarding rules for an IP address. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the port forwarding services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list port forwarding rules for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateTemplatePermissions + Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them. + false + + + id + the template ID + true + uuid + + + accounts + a comma delimited list of accounts within caller's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + isextractable + true if the template/iso is extractable, false other wise. Can be set only by root admin + false + boolean + + + isfeatured + true for featured template/iso, false otherwise + false + boolean + + + ispublic + true for public template/iso, false for private templates/isos + false + boolean + + + op + permission operator (add, remove, reset) + false + string + + + projectids + a comma delimited list of projects. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + resetPasswordForVirtualMachine + Resets the password for virtual machine. The virtual machine must be in a "Stopped" state and the template must already support this feature for this command to take effect. [async] + true + + + id + The ID of the virtual machine + true + uuid + + + password + The new password of the virtual machine. If null, a random password will be generated for the VM. + false + 4.19.0 + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listBrocadeVcsDevices + Lists Brocade VCS Switches + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + vcsdeviceid + Brocade VCS switch ID + false + uuid + + + + + brocadedevicename + device name + string + + + hostname + the principal switch Ip address + string + + + physicalnetworkid + the physical Network to which this Brocade VCS belongs to + string + + + provider + name of the provider + string + + + vcsdeviceid + device id of the Brocade Vcs + string + + + false + + + linkDomainToLdap + link an existing cloudstack domain to group or OU in ldap + false + 4.6.0 + + + accounttype + Type of the account to auto import. Specify 0 for user and 2 for domain admin + true + integer + + + domainid + The id of the domain which has to be linked to LDAP. + true + uuid + + + type + type of the ldap name. GROUP or OU + true + string + + + admin + domain admin username in LDAP + false + string + + + ldapdomain + name of the group or OU in LDAP + false + string + + + name + name of the group or OU in LDAP + false + string + + + + + accountid + Domain Admin accountId that is created + string + + + accounttype + Type of the account to auto import + int + + + domainid + id of the Domain which is linked to LDAP + string + + + ldapdomain + name of the group or OU in LDAP which is linked to the domain + string + + + name + name of the group or OU in LDAP which is linked to the domain + string + + + type + type of the name in LDAP which is linked to the domain + string + + + false + + + setupUserTwoFactorAuthentication + Setup the 2FA for the user. + false + 4.18.0 + + + enable + Enabled by default, provide false to disable 2FA + false + boolean + + + provider + two factor authentication code + false + string + + + userid + optional: the id of the user for which 2FA has to be disabled + false + uuid + + + + + id + the user ID + string + + + accountid + the account ID of the user + string + + + secretcode + secret code that needs to be registered with authenticator + string + + + username + the user name + string + + + false + + + listVpnCustomerGateways + Lists site to site vpn customer gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + id of the customer gateway + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + deleteKubernetesCluster + Deletes a Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + cleanup + Destroy attached instances of the ExternalManaged Cluster. Default: false + false + 4.19.0 + boolean + + + expunge + Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false + false + 4.19.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAndSwitchSamlAccount + Lists and switches to other SAML accounts owned by the SAML user + false + + + domainid + Domain uuid + false + uuid + + + userid + User uuid + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createGlobalLoadBalancerRule + Creates a global load balancer rule + true + + + gslbdomainname + domain name for the GSLB service. + true + string + + + gslbservicetype + GSLB service type (tcp, udp, http) + true + string + + + name + name of the load balancer rule + true + string + + + regionid + region where the global load balancer is going to be created. + true + integer + + + account + the account associated with the global load balancer. Must be used with the domainId parameter. + false + string + + + description + the description of the load balancer rule + false + string + + + domainid + the domain ID associated with the load balancer + false + uuid + + + gslblbmethod + load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin' + false + string + + + gslbstickysessionmethodname + session sticky method (sourceip) if not specified defaults to sourceip + false + string + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + deleteNetscalerLoadBalancer + delete a netscaler load balancer device + true + + + lbdeviceid + netscaler load balancer device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTags + List resource tag(s) + false + 4.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + customer + list by customer name + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + key + list by key + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + list by resource id + false + string + + + resourcetype + list by resource type + false + string + + + value + list by value + false + string + + + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + false + + + listAffectedVmsForStorageScopeChange + List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster. + false + 4.19.1 + + + clusterid + the Id of the cluster the scope of the storage pool is being changed to + true + uuid + + + storageid + the Id of the storage pool on which change scope operation is being done + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the VM + string + + + clusterid + the cluster ID for the VM + string + + + clustername + the cluster name for the VM + string + + + hostid + the host ID for the VM + string + + + hostname + the hostname for the VM + string + + + name + the name of the VM + string + + + type + the type of VM + string + + + false + + + createVirtualRouterElement + Create a virtual router element. + true + + + nspid + the network service provider ID of the virtual router element + true + uuid + + + providertype + The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + createVPC + Creates a VPC + true + + + cidr + the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR + true + string + + + name + the name of the VPC + true + string + + + vpcofferingid + the ID of the VPC offering + true + uuid + + + zoneid + the ID of the availability zone + true + uuid + + + account + the account associated with the VPC. Must be used with the domainId parameter. + false + string + + + displaytext + The display text of the VPC, defaults to its 'name'. + false + string + + + dns1 + the first IPv4 DNS for the VPC + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the VPC + false + 4.18.0 + string + + + domainid + the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain. + false + uuid + + + fordisplay + an optional field, whether to the display the vpc to the end user or not + false + 4.4 + boolean + + + ip6dns1 + the first IPv6 DNS for the VPC + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + false + 4.18.0 + string + + + networkdomain + VPC network domain. All networks inside the VPC will belong to this domain + false + string + + + projectid + create VPC for the project + false + uuid + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. +If an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented, + false + 4.19 + string + + + start + If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default. + false + 4.3 + boolean + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + removeResourceDetail + Removes detail for the Resource. + true + + + resourceid + Delete details for resource id + true + string + + + resourcetype + Delete detail by resource type + true + string + + + key + Delete details matching key/value pairs + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listOsTypes + Lists all supported OS types for this cloud. + false + + + description + list os by description + false + 3.0.1 + string + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.18.1 + boolean + + + id + list by Os type Id + false + uuid + + + keyword + List by keyword + false + string + + + oscategoryid + list by Os Category id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + fordisplay + is the guest OS visible for the users + boolean + + + isuserdefined + is the guest OS user defined + boolean + + + name + the name of the OS type + string + + + oscategoryid + the ID of the OS category + string + + + oscategoryname + the name of the OS category + string + + + false + + + removeGuestOs + Removes a Guest OS from listing. + true + 4.4.0 + + + id + ID of the guest OS + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + detachIso + Detaches any ISO file (if any) currently attached to a virtual machine. + true + + + virtualmachineid + The ID of the virtual machine + true + uuid + + + forced + If true, ejects the ISO before detaching on VMware. Default: false + false + 4.15.1 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deletePaloAltoFirewall + delete a Palo Alto firewall device + true + + + fwdeviceid + Palo Alto firewall device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deletePod + Deletes a Pod. + false + + + id + the ID of the Pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricProviders + Lists Tungsten-Fabric providers + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + false + uuid + + + + + name + Tungsten-Fabric provider name + string + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + tungstengateway + Tungsten-Fabric provider gateway + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + string + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + string + + + tungstenproviderport + Tungsten-Fabric provider port + string + + + tungstenprovideruuid + Tungsten-Fabric provider uuid + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listDeploymentPlanners + Lists all DeploymentPlanners available. + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + Deployment Planner name + string + + + false + + + deleteCluster + Deletes a cluster. + false + + + id + the cluster ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + prepareHostForMaintenance + Prepares a host for maintenance. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeRegion + Removes specified region + false + + + id + ID of the region to delete + true + integer + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getVolumeiScsiName + Get Volume's iSCSI Name + false + + + volumeid + CloudStack Volume UUID + true + string + + + + + volumeiScsiName + Volume iSCSI Name + string + + + false + + + updateAutoScaleVmGroup + Updates an existing autoscale vm group. + true + + + id + the ID of the autoscale group + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the group to the end user or not + false + 4.4 + boolean + + + interval + the frequency in which the performance counters to be collected + false + integer + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + false + integer + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + false + integer + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + scaledownpolicyids + list of scaledown autoscale policies + false + list + list + + + scaleuppolicyids + list of scaleup autoscale policies + false + list + list + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + deleteSnapshot + Deletes a snapshot of a disk volume. + true + + + id + The ID of the snapshot + true + uuid + + + zoneid + The ID of the zone for the snapshot + false + 4.19.0 + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVirtualMachines + List the virtual machines owned by the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + clusterid + the cluster ID + false + 4.16.0 + uuid + + + details + comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hostid + the host ID + false + uuid + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. + false + 4.19.0 + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + storageid + the storage ID where vm's volumes belong to + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userdataid + the instances by userdata + false + 4.20.1 + uuid + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listDiskOfferings + Lists all available disk offerings. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + encrypt + listed offerings support disk encryption + false + 4.18 + boolean + + + id + ID of the disk offering + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the disk offering + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings. + false + 4.19 + string + + + storageid + The ID of the storage pool, tags of the storage pool are used to filter the offerings + false + 4.17 + uuid + + + storagetype + the storage type of the service offering. Values are local and shared. + false + 4.19 + string + + + volumeid + The ID of the volume, tags of the volume are used to filter the offerings + false + 4.17 + uuid + + + zoneid + id of zone disk offering is associated with + false + 4.13 + uuid + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + state + state of the disk offering + string + + + storagetype + the storage type for this disk offering + string + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + deleteCiscoAsa1000vResource + Deletes a Cisco ASA 1000v appliance + false + + + resourceid + Cisco ASA 1000v resource ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + upgradeKubernetesCluster + Upgrades a running CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + kubernetesversionid + the ID of the Kubernetes version for upgrade + true + uuid + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + listProjects + Lists projects and provides detailed information for listed projects + false + 3.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + details + comma separated list of project details requested, value can be a list of [ all, resource, min] + false + list + list + + + displaytext + list projects by display text + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list projects by project ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list projects by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for projects + false + boolean + + + state + list projects by state + false + string + + + tags + List projects by tags (key/value pairs) + false + map + map + + + username + List projects by username + false + string + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createCondition + Creates a condition for VM auto scaling + true + + + counterid + ID of the Counter. + true + uuid + + + relationaloperator + Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE. + true + string + + + threshold + Value for which the Counter will be evaluated with the Operator selected. + true + long + + + account + the account of the condition. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID of the account. + false + uuid + + + projectid + an optional project for condition + false + uuid + + + + + id + the id of the Condition + string + + + account + the owner of the Condition. + string + + + counter + Details of the Counter. + counterresponse + + + counterid + the Id of the Counter. + string + + + countername + the Name of the Counter. + string + + + domain + the domain name of the owner. + string + + + domainid + the domain id of the Condition owner + string + + + domainpath + path of the domain to which the Condition owner belongs + 4.19.2.0 + string + + + project + the project name of the Condition + string + + + projectid + the project id of the Condition. + string + + + relationaloperator + Relational Operator to be used with threshold. + string + + + threshold + Threshold Value for the counter. + long + + + zoneid + zone id of counter + string + + + false + + + createAccount + Creates an account + false + + + email + email + true + string + + + firstname + firstname + true + string + + + lastname + lastname + true + string + + + password + Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Unique username. + true + string + + + account + Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accountid + Account UUID, required for adding account from external provisioning system + false + string + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + Creates the user under the specified domain. + false + uuid + + + networkdomain + Network domain for the account's networks + false + string + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + revertToVMSnapshot + Revert VM from a vmsnapshot. + true + 4.2.0 + + + vmsnapshotid + The ID of the vm snapshot + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTungstenFabricServiceGroup + create Tungsten-Fabric service group + true + + + endport + Tungsten-Fabric service group end port + true + integer + + + name + Tungsten-Fabric service group name + true + string + + + protocol + Tungsten-Fabric service group protocol + true + string + + + startport + Tungsten-Fabric service group start port + true + integer + + + zoneid + the ID of zone + true + uuid + + + + + endport + Tungsten-Fabric service group end port + int + + + name + Tungsten-Fabric service group name + string + + + protocol + Tungsten-Fabric service group protocol + string + + + startport + Tungsten-Fabric service group start port + int + + + uuid + Tungsten-Fabric service group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + removeGuestOsMapping + Removes a Guest OS Mapping. + true + 4.4.0 + + + id + ID of the guest OS mapping + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + registerIso + Registers an existing ISO into the CloudStack Cloud. + false + + + name + the name of the ISO + true + string + + + url + the URL to where the ISO is currently being hosted + true + string + + + zoneid + the ID of the zone you wish to register the ISO to. + true + uuid + + + account + an optional account name. Must be used with domainId. + false + string + + + bootable + true if this ISO is bootable. If not passed explicitly its assumed to be true + false + boolean + + + checksum + the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + directdownload + true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + displaytext + the display text of the ISO, defaults to the 'name' + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + imagestoreuuid + Image store UUID + false + string + + + isdynamicallyscalable + true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory + false + boolean + + + isextractable + true if the ISO or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if you want this ISO to be featured + false + boolean + + + ispublic + true if you want to register the ISO to be publicly available to all users, false otherwise. + false + boolean + + + ostypeid + the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed + false + uuid + + + passwordenabled + true if password reset feature is supported; default is false + false + boolean + + + projectid + Register ISO for the project + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listCiscoAsa1000vResources + Lists Cisco ASA 1000v appliances + false + + + hostname + Hostname or ip address of the Cisco ASA 1000v appliance. + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + resourceid + Cisco ASA 1000v resource ID + false + uuid + + + + false + + + deletePortableIpRange + deletes a range of portable public IP's associated with a region + true + + + id + Id of the portable ip range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + upgradeRouterTemplate + Upgrades router to use newer template + false + + + account + upgrades all routers owned by the specified account + false + string + + + clusterid + upgrades all routers within the specified cluster + false + uuid + + + domainid + upgrades all routers owned by the specified domain + false + uuid + + + id + upgrades router with the specified Id + false + uuid + + + podid + upgrades all routers within the specified pod + false + uuid + + + zoneid + upgrades all routers within the specified zone + false + uuid + + + + + jobid + the UUID of the latest async job acting on this object + string + + + jobstatus + the current status of the latest async job acting on this object + integer + + + false + + + listVlanIpRanges + Lists all VLAN IP ranges. + false + + + account + the account with which the VLAN IP range is associated. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain. + false + uuid + + + forvirtualnetwork + true if VLAN is of Virtual type, false if Direct + false + boolean + + + id + the ID of the VLAN IP range + false + uuid + + + keyword + List by keyword + false + string + + + networkid + network id of the VLAN IP range + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + physical network id of the VLAN IP range + false + uuid + + + podid + the Pod ID of the VLAN IP range + false + uuid + + + projectid + project who will own the VLAN + false + uuid + + + vlan + the ID or VID of the VLAN. Default is an "untagged" VLAN. + false + string + + + zoneid + the Zone ID of the VLAN IP range + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + updateZone + Updates a Zone. + false + + + id + the ID of the Zone + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + details + the details for the Zone + false + map + map + + + dhcpprovider + the dhcp Provider for the Zone + false + string + + + dns1 + the first DNS for the Zone + false + string + + + dns2 + the second DNS for the Zone + false + string + + + dnssearchorder + the dns search order list + false + list + list + + + domain + Network domain name for the networks in the zone; empty string will update domain with NULL value + false + string + + + guestcidraddress + the guest CIDR address for the Zone + false + string + + + internaldns1 + the first internal DNS for the Zone + false + string + + + internaldns2 + the second internal DNS for the Zone + false + string + + + ip6dns1 + the first DNS for IPv6 network in the Zone + false + string + + + ip6dns2 + the second DNS for IPv6 network in the Zone + false + string + + + ispublic + updates a private zone to public if set, but not vice-versa + false + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + false + boolean + + + name + the name of the Zone + false + string + + + sortkey + sort key of the zone, integer + false + integer + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + cancelHostMaintenance + Cancels host maintenance. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + extractVolume + Extracts volume + true + + + id + the ID of the volume + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + zoneid + the ID of the zone where the volume is located + true + uuid + + + url + the url to which the volume would be extracted + false + string + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + listProjectAccounts + Lists project's accounts + false + 3.0.0 + + + projectid + ID of the project + true + uuid + + + account + list accounts of the project by account name + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectroleid + list accounts of the project by project role id + false + uuid + + + role + list accounts of the project by role + false + string + + + userid + list invitation by user ID + false + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateAutoScalePolicy + Updates an existing autoscale policy. + true + + + id + the ID of the autoscale policy + true + uuid + + + conditionids + the list of IDs of the conditions that are being evaluated on every interval + false + list + list + + + duration + the duration in which the conditions have to be true before action is taken + false + integer + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + quiettime + the cool down period in which the policy should not be evaluated after the action has been taken + false + integer + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + domainpath + path of the domain to which the autoscale policy belongs + 4.19.2.0 + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + createDiskOffering + Creates a disk offering. + false + + + name + name of the disk offering + true + string + + + bytesreadrate + bytes read rate of the disk offering + false + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + long + + + byteswriterate + bytes write rate of the disk offering + false + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + long + + + cachemode + the cache mode to use for this disk offering. none, writeback or writethrough + false + 4.14 + string + + + customized + whether disk offering size is custom or not + false + boolean + + + customizediops + whether disk offering iops is custom or not + false + boolean + + + details + details to specify disk offering parameters + false + map + 4.16 + map + + + disksize + size of the disk offering in GB (1GB = 1,073,741,824 bytes) + false + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + false + 4.17 + boolean + + + displayoffering + an optional field, whether to display the offering to the end user or not. + false + boolean + + + displaytext + An alternate display text of the disk offering, defaults to 'name'. + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + encrypt + Volumes using this offering should be encrypted + false + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + false + integer + + + iopsreadrate + io requests read rate of the disk offering + false + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + long + + + iopswriterate + io requests write rate of the disk offering + false + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + long + + + maxiops + max iops of the disk offering + false + long + + + miniops + min iops of the disk offering + false + long + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + false + string + + + storagepolicy + Name of the storage policy defined at vCenter, this is applicable only for VMware + false + 4.15 + uuid + + + storagetype + the storage type of the disk offering. Values are local and shared. + false + string + + + tags + tags for the disk offering + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + state + state of the disk offering + string + + + storagetype + the storage type for this disk offering + string + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + listLBHealthCheckPolicies + Lists load balancer health check policies. + false + 4.2.0 + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the health check policy + false + 4.4 + uuid + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the load balancer rule + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + migrateVirtualMachineWithVolume + Attempts Migration of a VM with its volumes to a different host + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host for a running instance, if hostId is not specified. false by default + false + 4.19.0 + boolean + + + hostid + Destination Host ID to migrate VM to. + false + uuid + + + migrateto + Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=<uuid>&migrateto[volume-index].pool=<uuid>Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume=<uuid> indicates the UUID of the volume that you want to migrate, and pool=<uuid> indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc> + false + map + map + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateUser + Updates a user account + false + + + id + User uuid + true + uuid + + + currentpassword + Current password that was being used by the user. You must inform the current password when updating the password. + false + string + + + email + email + false + string + + + firstname + first name + false + string + + + lastname + last name + false + string + + + mandate2fa + Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA + false + 4.18.0.0 + boolean + + + password + Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port + false + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userapikey + The API key for the user. Must be specified with userSecretKey + false + string + + + username + Unique username + false + string + + + usersecretkey + The secret key for the user. Must be specified with userApiKey + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + removeCertFromLoadBalancer + Removes a certificate from a load balancer rule + true + + + lbruleid + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + attachVolume + Attaches a disk volume to a virtual machine. + true + + + id + the ID of the disk volume + true + uuid + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + deviceid + The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.<br>When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:<ul><li>0 maps to /dev/xvda;</li><li>1 maps to /dev/xvdb;</li><li>2 maps /dev/xvdc and so on.</li></ul>Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure. + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addHost + Adds a new host. + false + + + hypervisor + hypervisor type of the host + true + string + + + podid + the Pod ID for the host + true + uuid + + + url + the host URL + true + string + + + zoneid + the Zone ID for the host + true + uuid + + + allocationstate + Allocation state of this Host for allocation of new resources + false + string + + + clusterid + the cluster ID for the host + false + uuid + + + clustername + the cluster name for the host + false + string + + + hosttags + list of tags to be added to the host + false + list + list + + + password + the password for the host; required to be passed for hypervisors other than VMWare + false + string + + + username + the username for the host; required to be passed for hypervisors other than VMWare + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateProject + Updates a project + true + 3.0.0 + + + id + id of the project to be modified + true + uuid + + + account + new Admin account for the project + false + string + + + displaytext + display text of the project + false + string + + + name + name of the project + false + 4.19.0 + string + + + roletype + Account level role to be assigned to the user/account : Admin/Regular + false + string + + + swapowner + when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true + false + boolean + + + userid + ID of the user to be promoted/demoted + false + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listLoadBalancers + Lists internal load balancers + false + 4.2.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the load balancer + false + string + + + networkid + the network ID of the load balancer + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + scheme + the scheme of the load balancer. Supported value is internal in the current release + false + string + + + sourceipaddress + the source IP address of the load balancer + false + string + + + sourceipaddressnetworkid + the network ID of the source IP address + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + domainpath + path of the domain to which the Load Balancer belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteLBStickinessPolicy + Deletes a load balancer stickiness policy. + true + 3.0.0 + + + id + the ID of the LB stickiness policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + registerUserKeys + This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user + false + + + id + User id + true + uuid + + + + + apikey + the api key of the registered user + string + + + secretkey + the secret key of the registered user + string + + + false + + + listVpnConnections + Lists site to site vpn connection gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + id of the vpn connection + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + id of vpc + false + uuid + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + removeTungstenFabricPolicy + remove Tungsten-Fabric policy + true + + + networkuuid + the uuid of Tungsten-Fabric network + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateCloudToUseObjectStore + Migrate current NFS secondary storages to use object store. + false + 4.3.0 + + + provider + the image store provider name + true + string + + + details + the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + name + the name for the image store + false + string + + + url + the URL for the image store + false + string + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + addTungstenFabricNetworkGatewayToLogicalRouter + add Tungsten-Fabric network gateway to logical router + true + + + logicalrouteruuid + Tungsten-Fabric logical router uuid + true + string + + + networkuuid + Tungsten-Fabric network uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listTungstenFabricNic + list Tungsten-Fabric nic + false + + + keyword + List by keyword + false + string + + + nicuuid + the uuid of Tungsten-Fabric nic + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric nic name + string + + + uuid + Tungsten-Fabric nic uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listVmwareDcs + Retrieves VMware DC(s) associated with a zone. + false + + + zoneid + Id of the CloudStack zone. + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + applyTungstenFabricPolicy + apply Tungsten-Fabric policy + true + + + majorsequence + the major sequence of Tungsten-Fabric policy + true + integer + + + minorsequence + the minor sequence of Tungsten-Fabric policy + true + integer + + + networkuuid + the uuid of network + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listZones + Lists zones + false + + + available + true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false. + false + boolean + + + domainid + the ID of the domain associated with the zone + false + uuid + + + id + the ID of the zone + false + uuid + + + ids + the IDs of the zones, mutually exclusive with id + false + list + 4.19.0 + list + + + keyword + List by keyword + false + string + + + name + the name of the zone + false + string + + + networktype + the network type of the zone that the virtual machine belongs to + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the zones + false + boolean + + + showicon + flag to display the resource image for the zones + false + boolean + + + tags + List zones by resource tags (key/value pairs) + false + map + 4.3 + map + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + removeQuarantinedIp + Removes a public IP address from quarantine. Only IPs in active quarantine can be removed. + false + 4.19 + + + removalreason + The reason for removing the public IP address from quarantine prematurely. + true + string + + + id + The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine. + false + uuid + + + ipaddress + The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine. + false + string + + + + + id + ID of the quarantine process. + string + + + created + When the quarantine was created. + date + + + enddate + End date for the quarantine. + date + + + ipaddress + The public IP address in quarantine. + string + + + previousownerid + Account ID of the previous public IP address owner. + string + + + previousownername + Account name of the previous public IP address owner. + string + + + removalreason + The reason for removing the IP from quarantine prematurely. + string + + + removed + When the quarantine was removed. + date + + + removeraccountid + ID of the account that removed the IP from quarantine. + string + + + false + + + deleteBackupSchedule + Deletes the backup schedule of a VM + false + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBackupProviderOfferings + Lists external backup offerings of the provider + false + 4.14.0 + + + zoneid + The zone ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + releasePublicIpRange + Releases a Public IP range back to the system pool + false + + + id + the id of the Public IP range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetscalerLoadBalancerNetworks + lists network that are using a netscaler load balancer device + false + + + lbdeviceid + netscaler load balancer device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createTungstenFabricPublicNetwork + create Tungsten-Fabric public network + false + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkIsolationMethods + Lists supported methods of network isolation + false + 4.2.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + Network isolation method name + string + + + false + + + listHostHAResources + Lists host HA resources + false + 4.11 + + + hostid + List by host ID + false + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + listTungstenFabricFirewallPolicy + list Tungsten-Fabric firewall policy + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + firewallrule + list Tungsten-Fabric firewall rule + list + + + name + Tungsten-Fabric firewall policy name + string + + + uuid + Tungsten-Fabric firewall policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + importBackupOffering + Imports a backup offering using a backup provider + true + 4.14.0 + + + allowuserdrivenbackups + Whether users are allowed to create adhoc backups and backup schedules + true + boolean + + + description + the description of the backup offering + true + string + + + externalid + The backup offering ID (from backup provider side) + true + string + + + name + the name of the backup offering + true + string + + + zoneid + The zone ID + true + uuid + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + deleteDomain + Deletes a specified domain + true + + + id + ID of domain to delete + true + uuid + + + cleanup + true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateVolume + Migrate volume + true + 3.0.0 + + + storageid + destination storage pool ID to migrate the volume to + true + uuid + + + volumeid + the ID of the volume + true + uuid + + + livemigrate + if the volume should be live migrated when it is attached to a running vm + false + boolean + + + newdiskofferingid + The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to. + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTungstenFabricApplicationPolicySet + create Tungsten-Fabric application policy set + true + + + name + Tungsten-Fabric application policy set name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + firewallpolicy + list Tungsten-Fabric firewall policy + list + + + name + Tungsten-Fabric policy name + string + + + tag + list Tungsten-Fabric tag + list + + + uuid + Tungsten-Fabric application policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listEvents + A command to list events. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + archived + true to list archived events otherwise false + false + 4.19.0 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + duration + the duration of the event + false + integer + + + enddate + the end date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss") + false + date + + + entrytime + the time the event was entered + false + integer + + + id + the ID of the event + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + level + the event level (INFO, WARN, ERROR) + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + the ID of the resource associated with the event + false + 4.17.0 + string + + + resourcetype + the type of the resource associated with the event + false + 4.17.0 + string + + + startdate + the start date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss") + false + date + + + startid + the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event + false + uuid + + + type + the event type (see event types) + false + string + + + + + id + the ID of the event + string + + + account + the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group) + string + + + archived + whether the event has been archived or not + boolean + + + created + the date the event was created + date + + + description + a brief description of the event + string + + + domain + the name of the account's domain + string + + + domainid + the id of the account's domain + string + + + domainpath + path of the Domain the account's domain belongs to + 4.19.2.0 + string + + + level + the event level (INFO, WARN, ERROR) + string + + + parentid + whether the event is parented + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + resourceid + the id of the resource + 4.17.0 + string + + + resourcename + the name of the resource + 4.17.0 + string + + + resourcetype + the type of the resource + 4.17.0 + string + + + state + the state of the event + state + + + type + the type of the event (see event types) + string + + + username + the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine) + string + + + false + + + listHostHAProviders + Lists HA providers + false + 4.11 + + + hypervisor + Hypervisor type of the resource + true + string + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + createTags + Creates resource tag(s) + true + 4.0.0 + + + resourceids + list of resources to create the tags for + true + list + list + + + resourcetype + type of the resource + true + string + + + tags + Map of tags (key/value pairs) + true + map + map + + + customer + identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + resetApiLimit + Reset api count + false + + + account + the ID of the account whose limit to be reset + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createInternalLoadBalancerElement + Create an Internal Load Balancer element. + true + 4.2.0 + + + nspid + the network service provider ID of the internal load balancer element + true + uuid + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + deleteVlanIpRange + Deletes a VLAN IP range. + false + + + id + the id of the VLAN IP range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + generateAlert + Generates an alert + true + 4.3 + + + description + Alert description + true + string + + + name + Name of the alert + true + string + + + type + Type of the alert + true + short + + + podid + Pod id for which alert is generated + false + uuid + + + zoneid + Zone id for which alert is generated + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + ldapConfig + (Deprecated, use addLdapConfiguration) Configure the LDAP context for this site. + false + 3.0.0 + + + binddn + Specify the distinguished name of a user with the search permission on the directory. + false + string + + + bindpass + Enter the password. + false + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + false + string + + + listall + If true return current LDAP configuration + false + boolean + + + port + Specify the LDAP port if required, default is 389. + false + integer + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain. + false + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com. + false + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL. + false + boolean + + + truststore + Enter the path to trust certificates store. + false + string + + + truststorepass + Enter the password for trust store. + false + string + + + + + binddn + Specify the distinguished name of a user with the search permission on the directory + string + + + bindpass + DN password + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + string + + + port + Specify the LDAP port if required, default is 389 + string + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL + string + + + true + + + listVsphereStoragePolicies + List vSphere storage policies + false + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the Storage Policy + string + + + description + the description of the Storage Policy + string + + + name + the name of the Storage Policy + string + + + policyid + the identifier of the Storage Policy in vSphere DataCenter + string + + + zoneid + the ID of the Zone + string + + + false + + + migrateVPC + moves a vpc to another physical network + true + 4.11.0 + + + vpcid + the ID of the vpc + true + uuid + + + vpcofferingid + vpc offering ID + true + uuid + + + resume + true if previous network migration cmd failed + false + boolean + + + tiernetworkofferings + network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2 + false + map + map + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deletePortForwardingRule + Deletes a port forwarding rule + true + + + id + the ID of the port forwarding rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteGlobalLoadBalancerRule + Deletes a global load balancer rule. + true + + + id + the ID of the global load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateAnnotationVisibility + update an annotation visibility. + false + 4.16 + + + id + the id of the annotation + true + string + + + adminsonly + the annotation is visible for admins only + true + boolean + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + updateConfiguration + Updates a configuration. + false + + + name + the name of the configuration + true + string + + + accountid + the ID of the Account to update the parameter value for corresponding account + false + uuid + + + clusterid + the ID of the Cluster to update the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to update the parameter value for corresponding domain + false + uuid + + + imagestoreuuid + the ID of the Image Store to update the parameter value for corresponding image store + false + uuid + + + storageid + the ID of the Storage pool to update the parameter value for corresponding storage pool + false + uuid + + + value + the value of the configuration + false + string + + + zoneid + the ID of the Zone to update the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + configureHAForHost + Configures HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + provider + HA provider + true + string + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + listVolumesUsageHistory + Lists volume stats + false + 4.18.0 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the volume. + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the volume + string + + + name + the name of the volume + string + + + stats + the list of VM stats + list + + + false + + + dedicatePublicIpRange + Dedicates a Public IP range to an account + false + + + id + the id of the VLAN IP range + true + uuid + + + domainid + domain ID of the account owning a VLAN + true + uuid + + + account + account who will own the VLAN + false + string + + + projectid + project who will own the VLAN + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + deleteBucket + Deletes an empty Bucket. + false + 4.19.0 + + + id + The ID of the Bucket + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createProjectRolePermission + Adds API permissions to a project role + false + 4.15.0 + + + permission + The rule permission, allow or deny. Default: deny. + true + string + + + projectid + ID of project where project role permission is to be created + true + uuid + + + projectroleid + ID of the project role + true + uuid + + + rule + The API name or wildcard rule such as list* + true + string + + + description + The description of the role permission + false + string + + + + + id + the ID of the project role permission + string + + + projectid + the ID of the project + string + + + projectroleid + the ID of the project role to which the role permission belongs + string + + + projectrolename + the name of the project role to which the role permission belongs + string + + + false + + + createConsoleEndpoint + Create a console endpoint to connect to a VM console + false + 4.18.0 + + + virtualmachineid + ID of the VM + true + uuid + + + token + (optional) extra security token, valid when the extra validation is enabled + false + string + + + + + details + details in case of an error + string + + + success + true if the console endpoint is generated properly + boolean + + + url + the console url + string + + + websocket + the console websocket options + consoleendpointwebsocketresponse + + + false + + + updateProjectRolePermission + Updates a project role permission and/or order + false + 4.15.0 + + + projectid + ID of project where project role permission is to be updated + true + uuid + + + projectroleid + ID of the project role + true + uuid + + + permission + Rule permission, can be: allow or deny + false + string + + + projectrolepermissionid + Project Role permission rule id + false + uuid + + + ruleorder + The parent role permission uuid, use 0 to move this rule at the top of the list + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addUserToProject + Adds user to a project + true + 4.14 + + + projectid + ID of the project to add the user to + true + uuid + + + username + Name of the user to be added to the project + true + string + + + email + email ID of user to which invitation to the project is going to be sent + false + string + + + projectroleid + ID of the project role + false + uuid + + + roletype + Project role type to be assigned to the user - Admin/Regular + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteTungstenFabricFirewallPolicy + delete Tungsten-Fabric firewall policy + true + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableHAForCluster + Disables HA cluster-wide + true + 4.11 + + + clusterid + ID of the cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + recoverVirtualMachine + Recovers a virtual machine. + false + + + id + The ID of the virtual machine + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + resetNetworkPermissions + Resets network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateTungstenFabricLBHealthMonitor + update Tungsten-Fabric loadbalancer health monitor + true + + + interval + loadbalancer health monitor interval + true + integer + + + lbruleid + the ID of lb rule + true + uuid + + + retry + loadbalancer health monitor retry + true + integer + + + timeout + loadbalancer health monitor timeout + true + integer + + + type + loadbalancer health monitor type + true + string + + + expectedcode + loadbalancer health monitor expected code + false + string + + + httpmethodtype + loadbalancer health monitor http method + false + string + + + urlpath + loadbalancer health monitor url path + false + string + + + + + id + the health monitor ID + long + + + expectedcode + the health monitor expected code + string + + + httpmethod + the health monitor http method + string + + + interval + the health monitor interval + int + + + lbruleid + the LB rule ID + string + + + retry + the health monitor retry + int + + + timeout + the health monitor timeout + int + + + type + the health monitor type + string + + + urlpath + the health monitor url path + string + + + uuid + the health monitor UUID + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + releaseDedicatedHost + Release the dedication for host + true + + + hostid + the ID of the host + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateProjectInvitation + Accepts or declines project invitation + true + 3.0.0 + + + projectid + id of the project to join + true + uuid + + + accept + if true, accept the invitation, decline if false. True by default + false + boolean + + + account + account that is joining the project + false + string + + + token + list invitations for specified account; this parameter has to be specified with domainId + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + revertSnapshot + This is supposed to revert a volume snapshot. This command is only supported with KVM so far + true + + + id + The ID of the snapshot + true + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateCondition + Updates a condition for VM auto scaling + true + 4.18.0 + + + id + the ID of the condition. + true + uuid + + + relationaloperator + Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE. + true + string + + + threshold + Value for which the Counter will be evaluated with the Operator selected. + true + long + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listRegions + Lists Regions + false + + + id + List Region by region ID. + false + integer + + + keyword + List by keyword + false + string + + + name + List Region by region name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + removeTungstenFabricTag + remove Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + networkuuid + the uuid of networks + false + list + list + + + nicuuid + the uuid of nics + false + list + list + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + vmuuid + the uuid of vms + false + list + list + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + migrateSystemVm + Attempts Migration of a system virtual machine to the host specified. + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default + false + 4.16.0 + boolean + + + hostid + destination Host ID to migrate VM to + false + uuid + + + storageid + Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume + false + 4.16.0 + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + listCounters + List the counters for VM auto scaling + false + + + id + ID of the Counter. + false + uuid + + + keyword + List by keyword + false + string + + + name + Name of the counter. + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + Network provider of the counter. + false + 4.18.0 + string + + + source + Source of the counter. + false + string + + + + + id + the id of the Counter + string + + + name + Name of the counter. + string + + + provider + Provider of the counter. + string + + + source + Source of the counter. + string + + + value + Value in case of snmp or other specific counters. + string + + + zoneid + zone id of counter + string + + + false + + + configureInternalLoadBalancerElement + Configures an Internal Load Balancer element. + true + 4.2.0 + + + id + the ID of the internal lb provider + true + uuid + + + enabled + Enables/Disables the Internal Load Balancer element + true + boolean + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + listVirtualRouterElements + Lists all available virtual router elements. + false + + + enabled + list network offerings by enabled state + false + boolean + + + id + list virtual router elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list virtual router elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + linkAccountToLdap + link a cloudstack account to a group or OU in ldap + false + 4.11.0 + + + account + name of the account, it will be created if it does not exist + true + string + + + domainid + The id of the domain that is to contain the linked account. + true + uuid + + + ldapdomain + name of the group or OU in LDAP + true + string + + + accounttype + Type of the account to auto import. Specify 0 for user and 2 for domain admin + false + integer + + + admin + domain admin username in LDAP + false + string + + + roleid + Creates the account under the specified role. + false + 4.19.1 + uuid + + + type + type of the ldap name. GROUP or OU, defaults to GROUP + false + string + + + + + accountid + Domain Admin accountId that is created + string + + + accounttype + Type of the account to auto import + int + + + domainid + id of the Domain which is linked to LDAP + string + + + ldapdomain + name of the group or OU in LDAP which is linked to the domain + string + + + name + name of the group or OU in LDAP which is linked to the domain + string + + + type + type of the name in LDAP which is linked to the domain + string + + + false + + + disableOutOfBandManagementForHost + Disables out-of-band management for a host + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + cancelHostAsDegraded + Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'. + true + 4.16.0.0 + + + id + host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createSecurityGroup + Creates a security group + false + + + name + name of the security group + true + string + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + description + the description of the security group + false + string + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + Create security group for project + false + uuid + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listNetworkPermissions + List network visibility and all accounts that have permissions to view this network. + false + 4.17.0 + + + networkid + Lists network permission by network ID + true + uuid + + + + + account + the account the network is available for + string + + + accountid + the ID of account the network is available for + string + + + domain + the name of the domain to which the network belongs + string + + + domainid + the ID of the domain to which the network belongs + string + + + networkid + the network ID + string + + + project + the project the network is available for + string + + + projectid + the ID of project the network is available for + string + + + false + + + removeVirtualMachineFromBackupOffering + Removes a VM from any existing backup offering + true + 4.14.0 + + + virtualmachineid + ID of the virtual machine + true + uuid + + + forced + Whether to force remove VM from the backup offering that may also delete VM backups. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVpnGateways + Lists site 2 site vpn gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + id of the vpn gateway + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + id of vpc + false + uuid + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + moveUser + Moves a user to another account in the same domain. + false + 4.11 + + + id + id of the user to be moved. + true + uuid + + + account + Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id. + false + string + + + accountid + Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name. + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + releaseHostReservation + Releases host reservation. + true + + + id + the host ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVpnConnection + Create site to site vpn connection + true + + + s2scustomergatewayid + id of the customer gateway + true + uuid + + + s2svpngatewayid + id of the vpn gateway + true + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + passive + connection is passive or not + false + boolean + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + listBrocadeVcsDeviceNetworks + lists network that are using a brocade vcs switch + false + + + vcsdeviceid + brocade vcs switch ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + dedicateHost + Dedicates a host. + true + + + domainid + the ID of the containing domain + true + uuid + + + hostid + the ID of the host to update + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the host + string + + + affinitygroupid + the Dedication Affinity Group ID of the host + string + + + domainid + the domain ID of the host + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + false + + + addGloboDnsHost + Adds the GloboDNS external host + true + 4.5.0 + + + password + Password for GloboDNS + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + GloboDNS url + true + string + + + username + Username for GloboDNS + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + logout + Logs out the user + false + + + + description + Response description + string + + + false + + + importRole + Imports a role based on provided map of rule permissions + false + 4.15.0 + + + name + Creates a role with this unique name + true + string + + + rules + Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing + true + map + map + + + description + The description of the role + false + string + + + forced + Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false. + false + boolean + + + ispublic + Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public). + false + boolean + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + quotaEmailTemplateUpdate + Updates existing email templates for quota alerts + false + 4.7.0 + + + templatebody + The quota email template body, max: 500k characters + true + string + + + templatesubject + The quota email template subject, max: 77 characters + true + string + + + templatetype + Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY + true + string + + + locale + The locale of the email text + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteTungstenFabricTagType + delete Tungsten-Fabric tag type + true + + + tagtypeuuid + the ID of Tungsten-Fabric tag type + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkServiceProviders + Lists network serviceproviders for a given physical network. + false + 3.0.0 + + + keyword + List by keyword + false + string + + + name + list providers by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + state + list providers by state + false + string + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + deleteObjectStoragePool + Deletes an Object Storage Pool + false + 4.19.0 + + + id + The Object Storage ID. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetscalerControlCenter + Delete Netscaler Control Center + false + + + id + Netscaler Control Center ID + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVolume + Deletes a detached disk volume. + false + + + id + The ID of the disk volume + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateSecondaryStorageSelector + Updates an existing secondary storage selector. + false + 4.19.0 + + + id + The unique identifier of the secondary storage selector. + true + uuid + + + heuristicrule + The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID. + true + string + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + enableUser + Enables a user account + false + + + id + Enables user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + quotaTariffCreate + Creates a quota tariff for a resource. + false + 4.18.0.0 + + + name + Quota tariff's name + true + string + + + usagetype + Integer value for the usage type of the resource. + true + integer + + + value + The quota tariff value of the resource as per the default unit. + true + double + + + activationrule + Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. + false + string + + + description + Quota tariff's description. + false + string + + + enddate + The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2009-06-03. + false + date + + + startdate + The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. Inform null to use the current date. + false + date + + + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + uuid + uuid + string + + + false + + + suspendProject + Suspends a project + true + 3.0.0 + + + id + id of the project to be suspended + true + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getApiLimit + Get API limit count for the caller + false + + + + account + the account name of the api remaining count + string + + + accountid + the account uuid of the api remaining count + string + + + apiAllowed + currently allowed number of apis + int + + + apiIssued + number of api already issued + int + + + expireAfter + seconds left to reset counters + long + + + false + + + deleteStorageNetworkIpRange + Deletes a storage network IP Range. + true + 3.0.0 + + + id + the uuid of the storage network ip range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addVmwareDc + Adds a VMware datacenter to specified zone + false + + + name + Name of VMware datacenter to be added to specified zone. + true + string + + + vcenter + The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + true + string + + + zoneid + The Zone ID. + true + uuid + + + password + The password for specified username. + false + string + + + username + The Username required to connect to resource. + false + string + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + updateIpv6FirewallRule + Updates Ipv6 firewall rule with specified ID + true + + + id + the ID of the ipv6 firewall rule + true + uuid + + + cidrlist + the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + endport + the ending port of Ipv6 firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the Ipv6 firewall rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + protocol + the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + false + string + + + startport + the starting port of Ipv6 firewall rule + false + integer + + + traffictype + the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateIsoPermissions + Updates ISO permissions + false + + + id + the template ID + true + uuid + + + accounts + a comma delimited list of accounts within caller's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + isextractable + true if the template/iso is extractable, false other wise. Can be set only by root admin + false + boolean + + + isfeatured + true for featured template/iso, false otherwise + false + boolean + + + ispublic + true for public template/iso, false for private templates/isos + false + boolean + + + op + permission operator (add, remove, reset) + false + string + + + projectids + a comma delimited list of projects. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVPCOffering + Deletes VPC offering + true + + + id + the ID of the VPC offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkACL + Deletes a network ACL + true + + + id + the ID of the network ACL + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricTag + create Tungsten-Fabric tag + true + + + tagtype + Tungsten-Fabric tag type + true + string + + + tagvalue + Tungsten-Fabric tag value + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + addOpenDaylightController + Adds an OpenDyalight controler + true + + + password + Credential to access the OpenDaylight API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + Api URL of the OpenDaylight Controller. + true + string + + + username + Username to access the OpenDaylight API + true + string + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + createZone + Creates a Zone. + false + + + dns1 + the first DNS for the Zone + true + string + + + internaldns1 + the first internal DNS for the Zone + true + string + + + name + the name of the Zone + true + string + + + networktype + network type of the zone, can be Basic or Advanced + true + string + + + allocationstate + Allocation state of this Zone for allocation of new resources + false + string + + + dns2 + the second DNS for the Zone + false + string + + + domain + Network domain name for the networks in the zone + false + string + + + domainid + the ID of the containing domain, null for public zones + false + uuid + + + guestcidraddress + the guest CIDR address for the Zone + false + string + + + internaldns2 + the second internal DNS for the Zone + false + string + + + ip6dns1 + the first DNS for IPv6 network in the Zone + false + string + + + ip6dns2 + the second DNS for IPv6 network in the Zone + false + string + + + isedge + true if the zone is an edge zone, false otherwise + false + 4.18.0 + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + false + boolean + + + securitygroupenabled + true if network is security group enabled, false otherwise + false + boolean + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listDomainChildren + Lists all children domains belonging to a specified domain + false + + + id + list children domain by parent domain ID. + false + uuid + + + isrecursive + to return the entire tree, use the value "true". To return the first level children, use the value "false". + false + boolean + + + keyword + List by keyword + false + string + + + listall + 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 + false + boolean + + + name + list children domains by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for domains + false + boolean + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + getVMPassword + Returns an encrypted password for the VM + false + + + id + The ID of the virtual machine + true + uuid + + + + + encryptedpassword + The base64 encoded encrypted password of the VM + string + + + false + + + assignToGlobalLoadBalancerRule + Assign load balancer rule or list of load balancer rules to a global load balancer rules. + true + + + id + the ID of the global load balancer rule + true + uuid + + + loadbalancerrulelist + the list load balancer rules that will be assigned to global load balancer rule + true + list + list + + + gslblbruleweightsmap + Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10' + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + importUnmanagedInstance + Import unmanaged virtual machine from a given cluster. + true + 4.14.0 + + + clusterid + the cluster ID + true + uuid + + + name + the name of the instance as it is known to the hypervisor + true + string + + + serviceofferingid + the service offering for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping using keys disk and diskOffering + false + map + map + + + details + used to specify the custom parameters. + false + map + map + + + displayname + the display name of the instance + false + string + + + domainid + import instance to the domain specified + false + uuid + + + forced + VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated + false + boolean + + + hostname + the host name of the instance + false + string + + + migrateallowed + vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool + false + boolean + + + nicipaddresslist + VM nic to ip address mapping using keys nic, ip4Address + false + map + map + + + nicnetworklist + VM nic to network id mapping using keys nic and network + false + map + map + + + projectid + import instance for the project + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addImageStoreS3 + Adds S3 Image Store + false + 4.7.0 + + + accesskey + S3 access key + true + string + + + bucket + Name of the storage bucket + true + string + + + endpoint + S3 endpoint + true + string + + + secretkey + S3 secret key + true + string + + + connectiontimeout + Connection timeout (milliseconds) + false + integer + + + connectionttl + Connection TTL (milliseconds) + false + integer + + + maxerrorretry + Maximum number of times to retry on error + false + integer + + + s3signer + Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType + false + string + + + sockettimeout + Socket timeout (milliseconds) + false + integer + + + usehttps + Use HTTPS instead of HTTP + false + boolean + + + usetcpkeepalive + Whether TCP keep-alive is used + false + boolean + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + uploadTemplateDirectDownloadCertificate + Upload a certificate for HTTPS direct template download on KVM hosts + false + 4.11.0 + + + certificate + SSL certificate + true + string + + + hypervisor + Hypervisor type + true + string + + + name + Name for the uploaded certificate + true + string + + + zoneid + Zone to upload certificate + true + uuid + + + hostid + (optional) the host ID to upload certificate + false + uuid + + + + + id + the direct download certificate id + string + + + alias + the direct download certificate alias + string + + + hostsmap + the hosts where the certificate is uploaded to + list + + + hypervisor + the hypervisor of the hosts where the certificate is uploaded + string + + + issuer + the direct download certificate issuer + string + + + serialnum + the direct download certificate serial num + string + + + subject + the direct download certificate subject + string + + + validity + the direct download certificate issuer + string + + + version + the direct download certificate version + string + + + zoneid + the zone id where the certificate is uploaded + string + + + zonename + the zone name where the certificate is uploaded + string + + + false + + + createPhysicalNetwork + Creates a physical network + true + 3.0.0 + + + name + the name of the physical network + true + string + + + zoneid + the Zone ID for the physical network + true + uuid + + + broadcastdomainrange + the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic + false + string + + + domainid + domain ID of the account owning a physical network + false + uuid + + + isolationmethods + the isolation method for the physical network[VLAN/L3/GRE] + false + list + list + + + networkspeed + the speed for the physical network[1G/10G] + false + string + + + tags + Tag the physical network + false + list + list + + + vlan + the VLAN for the physical network + false + string + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + listAutoScaleVmGroups + Lists autoscale vm groups. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the autoscale vm group + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the loadbalancer + false + uuid + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + page + false + integer + + + pagesize + false + integer + + + policyid + the ID of the policy + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vmprofileid + the ID of the profile + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + updatePod + Updates a Pod. + false + + + id + the ID of the Pod + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + endip + the ending IP address for the Pod + false + string + + + gateway + the gateway for the Pod + false + string + + + name + the name of the Pod + false + string + + + netmask + the netmask of the Pod + false + string + + + startip + the starting IP address for the Pod + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + attachIso + Attaches an ISO to a virtual machine. + true + + + id + the ID of the ISO file + true + uuid + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + forced + If true, ejects existing ISO before attaching on VMware. Default: false + false + 4.15.1 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + ldapRemove + (Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site. + false + 3.0.1 + + + + binddn + Specify the distinguished name of a user with the search permission on the directory + string + + + bindpass + DN password + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + string + + + port + Specify the LDAP port if required, default is 389 + string + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL + string + + + true + + + createUser + Creates a user for an account that already exists + false + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + true + string + + + email + email + true + string + + + firstname + firstname + true + string + + + lastname + lastname + true + string + + + password + Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Unique username. + true + string + + + domainid + Creates the user under the specified domain. Has to be accompanied with the account parameter + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + createVpnGateway + Creates site to site vpn local gateway + true + + + vpcid + public ip address id of the vpn gateway + true + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + addResourceDetail + Adds detail for the Resource. + true + + + details + Map of (key/value pairs) + true + map + map + + + resourceid + resource id to create the details for + true + string + + + resourcetype + type of the resource + true + string + + + fordisplay + pass false if you want this detail to be disabled for the regular user. True by default + false + 4.4 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVpnUsers + Lists vpn users + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + The uuid of the Vpn user + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + username + the username of the vpn user. + false + string + + + + + id + the vpn userID + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'. + string + + + username + the username of the vpn user + string + + + false + + + deleteIpForwardingRule + Deletes an IP forwarding rule + true + + + id + the ID of the forwarding rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + registerUserData + Register a new userdata. + false + 4.18 + + + name + Name of the userdata + true + string + + + userdata + Base64 encoded userdata content. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + true + string + + + account + an optional account for the userdata. Must be used with domainId. + false + string + + + domainid + an optional domainId for the userdata. If the account parameter is used, domainId must also be used. + false + uuid + + + params + comma separated list of variables declared in userdata content + false + string + + + projectid + an optional project for the userdata + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addRegion + Adds a Region + false + + + id + Id of the Region + true + integer + + + endpoint + Region service endpoint + true + string + + + name + Name of the region + true + string + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + generateUsageRecords + Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed + false + + + enddate + End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + true + date + + + startdate + Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + true + date + + + domainid + List events for the specified domain. + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateRolePermission + Updates a role permission order + false + 4.9.0 + + + roleid + ID of the role + true + uuid + + + permission + Rule permission, can be: allow or deny + false + 4.11 + string + + + ruleid + Role permission rule id + false + 4.11 + uuid + + + ruleorder + The parent role permission uuid, use 0 to move this rule at the top of the list + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAccounts + Lists accounts and provides detailed account information for listed accounts + false + + + accounttype + list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user). + false + integer + + + details + comma separated list of account details requested, value can be a list of [ all, resource, min] + false + list + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list account by account ID + false + uuid + + + iscleanuprequired + list accounts by cleanuprequired attribute (values are true or false) + false + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list account by account name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for accounts + false + boolean + + + state + list accounts by state. Valid states are enabled, disabled, and locked. + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + destroyRouter + Destroys a router. + true + + + id + the ID of the router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listImageStores + Lists image stores. + false + 4.2.0 + + + id + the ID of the storage pool + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the image store + false + string + + + page + false + integer + + + pagesize + false + integer + + + protocol + the image store protocol + false + string + + + provider + the image store provider + false + string + + + readonly + read-only status of the image store + false + 4.15.0 + boolean + + + zoneid + the Zone ID for the image store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + deleteAccount + Deletes a account, and all users associated with this account + true + + + id + Account id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableOutOfBandManagementForCluster + Disables out-of-band management for a cluster + true + 4.9.0 + + + clusterid + the ID of the cluster + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + deleteSslCert + Delete a certificate to CloudStack + false + + + id + Id of SSL certificate + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + activateProject + Activates a project + true + 3.0.0 + + + id + id of the project to be modified + true + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteAlerts + Delete one or more alerts. + false + + + enddate + end date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the alerts + false + list + list + + + startdate + start date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + delete by alert type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + registerOauthProvider + Register the OAuth2 provider in CloudStack + false + 4.19.0 + + + clientid + Client ID pre-registered in the specific OAuth provider + true + string + + + description + Description of the OAuth Provider + true + string + + + provider + Name of the provider from the list of OAuth providers supported in CloudStack + true + string + + + redirecturi + Redirect URI pre-registered in the specific OAuth provider + true + string + + + secretkey + Secret Key pre-registered in the specific OAuth provider + true + string + + + details + Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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 + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createAutoScaleVmProfile + Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature. + true + + + serviceofferingid + the service offering of the auto deployed virtual machine + true + uuid + + + templateid + the template of the auto deployed virtual machine + true + uuid + + + zoneid + availability zone for the auto deployed virtual machine + true + uuid + + + account + account that will own the autoscale VM profile + false + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + false + uuid + + + counterparam + counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161 + false + map + map + + + domainid + domain ID of the account owning a autoscale VM profile + false + uuid + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is expunged + false + integer + + + fordisplay + an optional field, whether to the display the profile to the end user or not + false + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. +Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 . +Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". + false + map + map + + + projectid + an optional project for the autoscale VM profile + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + 4.18.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18.1 + map + + + userdataid + the ID of the Userdata + false + 4.18.1 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + domainpath + path of the domain to which the vm profile belongs + 4.19.2.0 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base64 encoded VM user data + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.1 + string + + + userdataid + the id of userdata used for the VM + 4.18.1 + string + + + userdataname + the name of userdata used for the VM + 4.18.1 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.1 + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + listLBStickinessPolicies + Lists load balancer stickiness policies. + false + 3.0.0 + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer stickiness policy + false + uuid + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the load balancer rule + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + addUcsManager + Adds a Ucs manager + false + + + password + the password of UCS + true + string + + + url + the name of UCS url + true + string + + + username + the username of UCS + true + string + + + zoneid + the Zone id for the ucs manager + true + uuid + + + name + the name of UCS manager + false + string + + + + + id + the ID of the ucs manager + string + + + name + the name of ucs manager + string + + + url + the url of ucs manager + string + + + zoneid + the zone ID of ucs manager + string + + + false + + + deleteVnfTemplate + Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected. + true + 4.19.0 + + + id + the ID of the template + true + uuid + + + forced + Force delete a template. + false + 4.9+ + boolean + + + zoneid + the ID of zone of the template + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetscalerLoadBalancers + lists netscaler load balancer devices + false + + + keyword + List by keyword + false + string + + + lbdeviceid + netscaler load balancer device ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + createInstanceGroup + Creates a vm group + false + + + name + the name of the instance group + true + string + + + account + the account of the instance group. The account parameter must be used with the domainId parameter. + false + string + + + domainid + the domain ID of account owning the instance group + false + uuid + + + projectid + The project of the instance group + false + uuid + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + domainpath + path of the Domain the instance group belongs to + 4.19.2.0 + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + createLoadBalancer + Creates an internal load balancer + true + 4.2.0 + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + true + string + + + instanceport + the TCP port of the virtual machine where the network traffic will be load balanced to + true + integer + + + name + name of the load balancer + true + string + + + networkid + The guest network the load balancer will be created for + true + uuid + + + scheme + the load balancer scheme. Supported value in this release is Internal + true + string + + + sourceipaddressnetworkid + the network id of the source ip address + true + uuid + + + sourceport + the source port the network traffic will be load balanced from + true + integer + + + description + the description of the load balancer + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + sourceipaddress + the source IP address the network traffic will be load balanced from + false + string + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + domainpath + path of the domain to which the Load Balancer belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateBackupSchedule + Updates a user-defined VM backup schedule + false + 4.14.0 + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + schedule + custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + date + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + addPaloAltoFirewall + Adds a Palo Alto firewall device + true + + + networkdevicetype + supports only PaloAltoFirewall + true + string + + + password + Credentials to reach Palo Alto firewall device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the Palo Alto appliance. + true + string + + + username + Credentials to reach Palo Alto firewall device + true + string + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + createPrivateGateway + Creates a private gateway + true + 4.17.0 + + + gateway + the gateway of the Private gateway + true + string + + + ipaddress + the IP address of the Private gateaway + true + string + + + netmask + the netmask of the Private gateway + true + string + + + vpcid + the VPC network belongs to + true + uuid + + + aclid + the ID of the network ACL + false + uuid + + + associatednetworkid + The isolated network this private gateway is associated to. + false + 4.17.0 + uuid + + + bypassvlanoverlapcheck + when true bypasses VLAN id/range overlap check during private gateway creation + false + boolean + + + networkofferingid + the uuid of the network offering to use for the private gateways network connection + false + uuid + + + physicalnetworkid + the Physical Network ID the network belongs to + false + uuid + + + sourcenatsupported + source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported + false + boolean + + + vlan + the network implementation uri for the private gateway + false + string + + + + + id + the id of the private gateway + string + + + account + the account associated with the private gateway + string + + + aclid + ACL Id set for private gateway + string + + + aclname + ACL name set for private gateway + string + + + domain + the domain associated with the private gateway + string + + + domainid + the ID of the domain associated with the private gateway + string + + + domainpath + path of the domain to which the private gateway belongs + 4.19.2.0 + string + + + gateway + the gateway + string + + + ipaddress + the private gateway's ip address + string + + + netmask + the private gateway's netmask + string + + + physicalnetworkid + the physical network id + string + + + project + the project name of the private gateway + string + + + projectid + the project id of the private gateway + string + + + sourcenatsupported + Source Nat enable status + boolean + + + state + State of the gateway, can be Creating, Ready, Deleting + string + + + vlan + the network implementation uri for the private gateway + string + + + vpcid + VPC id the private gateway belongs to + string + + + vpcname + VPC name the private gateway belongs to + 4.13.2 + string + + + zoneid + zone id of the private gateway + string + + + zonename + the name of the zone the private gateway belongs to + string + + + false + + + updateOauthProvider + Updates the registered OAuth provider details + false + 4.19.0 + + + id + id of the OAuth provider to be updated + true + uuid + + + clientid + Client ID pre-registered in the specific OAuth provider + false + string + + + description + Description of the OAuth Provider + false + string + + + enabled + OAuth provider will be enabled or disabled based on this value + false + boolean + + + redirecturi + Redirect URI pre-registered in the specific OAuth provider + false + string + + + secretkey + Secret Key pre-registered in the specific OAuth provider + false + string + + + + + id + ID of the provider + string + + + clientid + Client ID registered in the OAuth provider + string + + + description + Description of the provider registered + string + + + enabled + Whether the OAuth provider is enabled or not + boolean + + + name + Name of the provider + string + + + provider + Name of the provider + string + + + redirecturi + Redirect URI registered in the OAuth provider + string + + + secretkey + Secret key registered in the OAuth provider + string + + + false + + + uploadSslCert + Upload a certificate to CloudStack + false + + + certificate + SSL certificate + true + string + + + name + Name for the uploaded certificate + true + string + + + privatekey + Private key + true + string + + + account + account that will own the SSL certificate + false + string + + + certchain + Certificate chain of trust + false + string + + + domainid + domain ID of the account owning the SSL certificate + false + uuid + + + enabledrevocationcheck + Enables revocation checking for certificates + false + 4.15 + boolean + + + password + Password for the private key + false + string + + + projectid + an optional project for the SSL certificate + false + uuid + + + + + id + SSL certificate ID + string + + + account + account for the certificate + string + + + certchain + certificate chain + string + + + certificate + certificate + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + fingerprint + certificate fingerprint + string + + + loadbalancerrulelist + List of loabalancers this certificate is bound to + list + + + name + name + string + + + project + the project name of the certificate + string + + + projectid + the project id of the certificate + string + + + false + + + deleteFirewallRule + Deletes a firewall rule + true + + + id + the ID of the firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVpnCustomerGateway + Creates site to site vpn customer gateway + true + + + cidrlist + guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,). + true + string + + + esppolicy + ESP policy of the customer gateway + true + string + + + gateway + public ip address id of the customer gateway + true + string + + + ikepolicy + IKE policy of the customer gateway + true + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes. + true + string + + + account + the account associated with the gateway. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain. + false + uuid + + + dpd + If DPD is enabled for VPN connection + false + boolean + + + esplifetime + Lifetime of phase 2 VPN connection to the customer gateway, in seconds + false + long + + + forceencap + Force Encapsulation for NAT traversal + false + boolean + + + ikelifetime + Lifetime of phase 1 VPN connection to the customer gateway, in seconds + false + long + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike + false + 4.15.1 + string + + + name + name of this customer gateway + false + string + + + projectid + create site-to-site VPN customer gateway for the project + false + 4.6 + uuid + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + false + 4.15.1 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + addBaremetalHost + add a baremetal host + false + + + hypervisor + hypervisor type of the host + true + string + + + podid + the Pod ID for the host + true + uuid + + + url + the host URL + true + string + + + zoneid + the Zone ID for the host + true + uuid + + + allocationstate + Allocation state of this Host for allocation of new resources + false + string + + + clusterid + the cluster ID for the host + false + uuid + + + clustername + the cluster name for the host + false + string + + + hosttags + list of tags to be added to the host + false + list + list + + + ipaddress + ip address intentionally allocated to this host after provisioning + false + string + + + password + the password for the host; required to be passed for hypervisors other than VMWare + false + string + + + username + the username for the host; required to be passed for hypervisors other than VMWare + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeAnnotation + remove an annotation. + false + 4.11 + + + id + the id of the annotation + true + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + deleteRolePermission + Deletes a role permission + false + 4.9.0 + + + id + ID of the role permission + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateVMSchedule + Update VM Schedule. + false + 4.19.0 + + + id + ID of VM schedule + true + uuid + + + description + Name of the schedule + false + string + + + enabled + Enable VM schedule + false + boolean + + + enddate + end date after which the schedule becomes inactiveUse format "yyyy-MM-dd hh:mm:ss") + false + date + + + schedule + Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month' + false + string + + + startdate + start date from which the schedule becomes activeUse format "yyyy-MM-dd hh:mm:ss") + false + date + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + false + string + + + + + id + the ID of VM schedule + string + + + action + Action + action + + + created + Date when the schedule was created + date + + + description + Description of VM schedule + string + + + enabled + VM schedule is enabled + boolean + + + enddate + Date after which the schedule becomes inactive + date + + + schedule + Cron formatted VM schedule + string + + + startdate + Date from which the schedule is active + date + + + timezone + Timezone of the schedule + string + + + virtualmachineid + ID of virtual machine + string + + + false + + + listConfigurationGroups + Lists all configuration groups (primarily used for UI). + false + 4.18.0 + + + group + lists configuration group by group name + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + description + the description of the configuration group + string + + + name + the name of the configuration group + string + + + precedence + the precedence of the configuration group + long + + + subgroup(*) + the subgroups of the configuration group + + + name + the name of the configuration subgroup + string + + + precedence + the precedence of the configuration subgroup + long + + + list + + + false + + + releasePodIpAddress + Releases a Pod IP back to the Pod + false + + + id + UUID of the Pod IP + true + long + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateRemoteAccessVpn + Updates remote access vpn + true + 4.4 + + + id + id of the remote access vpn + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + destroyVirtualMachine + Destroys a virtual machine. Once destroyed, only the administrator can recover it. + true + + + id + The ID of the virtual machine + true + uuid + + + expunge + If true is passed, the vm is expunged immediately. False by default. + false + 4.2.1 + boolean + + + volumeids + Comma separated list of UUIDs for volumes that will be deleted + false + list + 4.12.0 + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + assignVirtualMachineToBackupOffering + Assigns a VM to a backup offering + true + 4.14.0 + + + backupofferingid + ID of the backup offering + true + uuid + + + virtualmachineid + ID of the virtual machine + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + startVirtualMachine + Starts a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + bootintosetup + Boot into hardware setup menu or not + false + 4.15.0.0 + boolean + + + clusterid + destination Cluster ID to deploy the VM to - parameter available for root admin only + false + uuid + + + considerlasthost + True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process. + false + 4.18.0 + boolean + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + 3.0.1 + uuid + + + podid + destination Pod ID to deploy the VM to - parameter available for root admin only + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listResourceIcon + Lists the resource icon for the specified resource(s) + false + 4.16.0.0 + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + base64image + base64 representation of resource icon + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + resourceobjecttype + + + false + + + createPod + Creates a new Pod. + false + + + name + the name of the Pod + true + string + + + zoneid + the Zone ID in which the Pod will be created + true + uuid + + + allocationstate + Allocation state of this Pod for allocation of new resources + false + string + + + endip + the ending IP address for the Pod + false + string + + + gateway + the gateway for the Pod + false + string + + + netmask + the netmask for the Pod + false + string + + + startip + the starting IP address for the Pod + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + removeRawUsageRecords + Safely removes raw records from cloud_usage table + false + 4.6.0 + + + interval + 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 + true + integer + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + provisionCertificate + Issues and propagates client certificate on a connected host/agent using configured CA plugin + true + 4.11.0 + + + hostid + The host/agent uuid to which the certificate has to be provisioned (issued and propagated) + true + uuid + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + reconnect + Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVirtualMachinesMetrics + Lists VM metrics + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + clusterid + the cluster ID + false + uuid + + + details + comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hostid + the host ID + false + uuid + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. + false + 4.19.0 + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + storageid + the storage ID where vm's volumes belong to + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userdataid + the instances by userdata + false + 4.20.1 + uuid + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + cputotal + the total cpu capacity in Ghz + string + + + diskiopstotal + the total disk iops + long + + + diskread + disk read in MiB + string + + + diskwrite + disk write in MiB + string + + + memorytotal + the total memory capacity in GiB + string + + + networkread + network read in MiB + string + + + networkwrite + network write in MiB + string + + + false + + + listHosts + Lists hosts. + false + + + clusterid + lists hosts existing in particular cluster + false + uuid + + + details + comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats] + false + list + list + + + hahost + if true, list only hosts dedicated to HA + false + boolean + + + hypervisor + hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator + false + string + + + id + the id of the host + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the host + false + string + + + outofbandmanagementenabled + list hosts for which out-of-band management is enabled + false + boolean + + + outofbandmanagementpowerstate + list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown] + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID for the host + false + uuid + + + resourcestate + 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] + false + string + + + state + the state of the host + false + string + + + type + the host type + false + string + + + virtualmachineid + lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM + false + uuid + + + zoneid + the Zone ID for the host + false + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteStoragePool + Deletes a storage pool. + false + + + id + Storage pool id + true + uuid + + + forced + Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal) + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteGuestNetworkIpv6Prefix + Deletes an existing guest network IPv6 prefix. + true + 4.17.0.0 + + + id + Id of the guest network IPv6 prefix + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateStoragePool + Updates a storage pool. + false + 3.0.0 + + + id + the Id of the storage pool + true + uuid + + + capacitybytes + bytes CloudStack can provision from this storage pool + false + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + false + long + + + details + the details for the storage pool + false + map + 4.19.0 + map + + + enabled + false to disable the pool for allocation of new volumes, true to enable it back. + false + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + false + boolean + + + name + Change the name of the storage pool + false + 4.15 + string + + + tags + comma-separated list of tags for the storage pool + false + list + list + + + url + the URL of the storage pool + false + 4.19.0 + string + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTungstenFabricTag + Lists Tungsten-Fabric tags + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + keyword + List by keyword + false + string + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + nicuuid + the uuid of Tungsten-Fabric nic + false + string + + + page + false + integer + + + pagesize + false + integer + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + taguuid + the uuid of Tungsten-Fabric tag + false + string + + + vmuuid + the uuid of Tungsten-Fabric vm + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + importLdapUsers + Import LDAP users + false + 4.3.0 + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + 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 + false + uuid + + + group + Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported. + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + moveDomain + Moves a domain and its children to a new parent domain. + false + 4.19.0.0 + + + domainid + The ID of the domain to be moved. + true + uuid + + + parentdomainid + The ID of the new parent domain of the domain to be moved. + true + uuid + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + listNetworks + Lists all available networks. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + acltype + list networks by ACL (access control list) type. Supported values are account and domain + false + string + + + associatednetworkid + List networks by associated networks. Only available if create a Shared network. + false + 4.17.0 + uuid + + + canusefordeploy + list networks available for VM deployment + false + boolean + + + displaynetwork + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvpc + the network belongs to VPC + false + boolean + + + id + list networks by ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issystem + true if network is system, false otherwise + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkfilter + possible values are "account", "domain", "accountdomain","shared", and "all". Default value is "all".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared). + false + 4.17.0 + string + + + networkofferingid + list networks by network offering ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + list networks by physical network id + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + restartrequired + list networks by restartRequired + false + boolean + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + showicon + flag to display the resource icon for networks + false + boolean + + + specifyipranges + true if need to list only networks which support specifying IP ranges + false + boolean + + + supportedservices + list networks supporting certain services + false + list + list + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + type of the traffic + false + string + + + type + the type of the network. Supported values are: isolated, l2, shared and all + false + string + + + vlan + the ID or VID of the network + false + 4.17.0 + string + + + vpcid + List networks by VPC + false + uuid + + + zoneid + the zone ID of the network + false + uuid + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + releaseIpAddress + Releases an IP address from the account. + false + 4.17 + + + id + the ID of the public IP address to release + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updatePodManagementNetworkIpRange + Updates a management network IP range. Only allowed when no IPs are allocated. + true + 4.16.0.0 + + + currentendip + The current ending IP address. + true + string + + + currentstartip + The current starting IP address. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + newendip + The new ending IP address. + false + string + + + newstartip + The new starting IP address. + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateFirewallRule + Updates firewall rule + true + 4.4 + + + id + the ID of the firewall rule + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + quotaIsEnabled + Return true if the plugin is enabled + false + 4.7.0 + + + + isenabled + is quota service enabled + boolean + + + false + + + quotaEmailTemplateList + Lists all quota email templates + false + 4.7.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + templatetype + List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY + false + string + + + + + last_updated + Last date/time when template was updated + date + + + locale + The quota email template locale + string + + + templatebody + The quota email template content + string + + + templatesubject + The quota email template subject + string + + + templatetype + Template type + string + + + false + + + deleteOauthProvider + Deletes the registered OAuth provider + false + 4.19.0 + + + id + id of the OAuth provider to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listHypervisors + List hypervisors + false + + + zoneid + the zone id for listing hypervisors. + false + uuid + + + + + name + Hypervisor name + string + + + false + + + listHostsMetrics + Lists hosts metrics + false + 4.9.3 + + + clusterid + lists hosts existing in particular cluster + false + uuid + + + details + comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats] + false + list + list + + + hahost + if true, list only hosts dedicated to HA + false + boolean + + + hypervisor + hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator + false + string + + + id + the id of the host + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the host + false + string + + + outofbandmanagementenabled + list hosts for which out-of-band management is enabled + false + boolean + + + outofbandmanagementpowerstate + list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown] + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID for the host + false + uuid + + + resourcestate + 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] + false + string + + + state + the state of the host + false + string + + + type + the host type + false + string + + + virtualmachineid + lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM + false + uuid + + + zoneid + the Zone ID for the host + false + uuid + + + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedghz + the total cpu allocated in Ghz + string + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpuloadaverage + the average cpu load the last minute + double + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotalghz + the total cpu capacity in Ghz + string + + + cpuusedghz + the total cpu used in Ghz + string + + + instances + instances on the host + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedgb + the total memory allocated in GiB + string + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotalgb + the total memory capacity in GiB + string + + + memoryusedgb + the total memory used in GiB + string + + + networkread + network read in GiB + string + + + networkwrite + network write in GiB + string + + + powerstate + out-of-band management power state + powerstate + + + systeminstances + system vm instances on the host + string + + + false + + + releaseDedicatedPod + Release the dedication for the pod + true + + + podid + the ID of the Pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAffinityGroups + Lists affinity groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list the affinity group by the ID provided + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + lists affinity groups by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + type + lists affinity groups by type + false + string + + + virtualmachineid + lists affinity groups by virtual machine ID + false + uuid + + + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + false + + + cancelShutdown + Cancels a triggered shutdown + false + 4.19.0 + + + managementserverid + the uuid of the management server + true + uuid + + + + + managementserverid + The id of the management server + string + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + registerSSHKeyPair + Register a public key in a keypair under a certain name + false + + + name + Name of the keypair + true + string + + + publickey + Public key material of the keypair + true + string + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the ssh key. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the ssh key + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the keypair + string + + + domain + the domain name of the keypair owner + string + + + domainid + the domain id of the keypair owner + string + + + fingerprint + Fingerprint of the public key + string + + + name + Name of the keypair + string + + + project + the project name of the keypair owner + string + + + projectid + the project id of the keypair owner + string + + + false + + + deleteEvents + Delete one or more events. + false + + + enddate + end date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the events + false + list + list + + + startdate + start date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + delete by event type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + reserveIpAddress + Reserve a public IP to an account. + false + 4.17 + + + id + the ID of the public IP address to reserve + true + uuid + + + account + the account to reserve with this IP address + false + string + + + domainid + the ID of the domain to reserve with this IP address + false + uuid + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + boolean + + + projectid + the ID of the project to reserve with this IP address + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteIso + Deletes an ISO file. + true + + + id + the ID of the ISO file + true + uuid + + + zoneid + the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVPCOfferings + Lists VPC offerings + false + + + displaytext + list VPC offerings by display text + false + string + + + domainid + list VPC offerings available for VPC creation in specific domain + false + 4.18 + uuid + + + id + list VPC offerings by id + false + uuid + + + isdefault + true if need to list only default VPC offerings. Default value is false + false + boolean + + + keyword + List by keyword + false + string + + + name + list VPC offerings by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + state + list VPC offerings by state + false + string + + + supportedservices + list VPC offerings supporting certain services + false + list + list + + + zoneid + id of zone VPC offering is associated with + false + 4.13 + uuid + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + getSolidFireVolumeSize + Get the SF volume size including Hypervisor Snapshot Reserve + false + + + volumeid + Volume UUID + true + string + + + + + solidFireVolumeSize + SolidFire Volume Size Including Hypervisor Snapshot Reserve + long + + + false + + + uploadVolume + Uploads a data disk. + true + + + format + the format for the volume. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume + true + string + + + url + the URL of where the volume is hosted. Possible URL include http:// and https:// + true + string + + + zoneid + the ID of the zone the volume is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + checksum + the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + diskofferingid + the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown. + false + uuid + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain. + false + uuid + + + imagestoreuuid + Image store uuid + false + string + + + projectid + Upload volume for the project + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + configureOutOfBandManagement + Configures a host's out-of-band management interface + false + 4.9.0 + + + address + the host management interface IP address + true + string + + + driver + the host management interface driver, for example: ipmitool + true + string + + + hostid + the ID of the host + true + uuid + + + password + the host management interface password + true + string + + + port + the host management interface port + true + string + + + username + the host management interface user + true + string + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listStorageTags + Lists storage tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the storage tag + string + + + name + the name of the storage tag + string + + + poolid + the pool ID of the storage tag + long + + + false + + + deleteVMSchedule + Delete VM Schedule. + false + 4.19.0 + + + virtualmachineid + ID of VM + true + uuid + + + id + ID of VM schedule + false + uuid + + + ids + IDs of VM schedule + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTemplatePermissions + List template visibility and all accounts that have permissions to view this template. + false + + + id + the template ID + true + uuid + + + + + id + the template ID + string + + + account + the list of accounts the template is available for + list + + + domainid + the ID of the domain to which the template belongs + string + + + ispublic + true if this template is a public template, false otherwise + boolean + + + projectids + the list of projects the template is available for + list + + + false + + + listAnnotations + Lists annotations. + false + 4.11 + + + annotationfilter + possible values are "self" and "all". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access + false + 4.16.0 + string + + + entityid + the id of the entity for which to show annotations + false + string + + + entitytype + the entity type + false + string + + + id + the id of the annotation + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + userid + optional: the id of the user of the annotation + false + 4.16.0 + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + addSwift + Adds Swift. + false + 3.0.0 + + + url + the URL for swift + true + string + + + account + the account for swift + false + string + + + key + key for the user for swift + false + string + + + username + the username for swift + false + string + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + listSnapshotPolicies + Lists snapshot policies. + false + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the snapshot policy + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + volumeid + the ID of the disk volume + false + uuid + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + zone + The list of zones in which snapshot backup is scheduled + 4.19.0 + set + + + false + + + updateVpnCustomerGateway + Update site to site vpn customer gateway + true + + + id + id of customer gateway + true + uuid + + + cidrlist + guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,). + true + string + + + esppolicy + ESP policy of the customer gateway + true + string + + + gateway + public ip address id of the customer gateway + true + string + + + ikepolicy + IKE policy of the customer gateway + true + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes. + true + string + + + account + the account associated with the gateway. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain. + false + uuid + + + dpd + If DPD is enabled for VPN connection + false + boolean + + + esplifetime + Lifetime of phase 2 VPN connection to the customer gateway, in seconds + false + long + + + forceencap + Force encapsulation for Nat Traversal + false + boolean + + + ikelifetime + Lifetime of phase 1 VPN connection to the customer gateway, in seconds + false + long + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike + false + 4.15.1 + string + + + name + name of this customer gateway + false + string + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + false + 4.15.1 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + applyTungstenFabricTag + apply Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + networkuuid + the uuid of networks + false + list + list + + + nicuuid + the uuid of nics + false + list + list + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + vmuuid + the uuid of vms + false + list + list + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateObjectStoragePool + Updates object storage pool + false + 4.19.0 + + + id + Object Store ID + true + uuid + + + name + the name for the object store + false + string + + + url + the url for the object store + false + string + + + + + id + the ID of the object store + string + + + name + the name of the object store + string + + + providername + the provider name of the object store + string + + + storagetotal + the total size of the object store + long + + + storageused + the object store currently used size + long + + + url + the url of the object store + string + + + false + + + stopRouter + Stops a router. + true + + + id + the ID of the router + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + lockAccount + This deprecated function used to locks an account. Look for the API DisableAccount instead + false + + + account + Locks the specified account. + true + string + + + domainid + Locks the specified account on this domain. + true + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + deleteProjectInvitation + Deletes project invitation + true + 3.0.0 + + + id + id of the invitation + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricFirewallPolicy + create Tungsten-Fabric firewall policy + true + + + name + Tungsten-Fabric firewall policy name + true + string + + + sequence + the sequence of Tungsten-Fabric firewall policy + true + integer + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + + + firewallrule + list Tungsten-Fabric firewall rule + list + + + name + Tungsten-Fabric firewall policy name + string + + + uuid + Tungsten-Fabric firewall policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateRegion + Updates a region + false + + + id + Id of region to update + true + integer + + + endpoint + updates region with this end point + false + string + + + name + updates region with this name + false + string + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + deleteTrafficType + Deletes traffic type of a physical network + true + 3.0.0 + + + id + traffic type id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listProjectRolePermissions + Lists a project's project role permissions + false + 4.15.0 + + + projectid + ID of the project + true + uuid + + + projectroleid + ID of the project role + false + uuid + + + + + id + the ID of the project role permission + string + + + projectid + the ID of the project + string + + + projectroleid + the ID of the project role to which the role permission belongs + string + + + projectrolename + the name of the project role to which the role permission belongs + string + + + false + + + listLdapConfigurations + Lists all LDAP configurations + false + 4.2.0 + + + domainid + linked domain + false + uuid + + + hostname + Hostname + false + string + + + keyword + List by keyword + false + string + + + listall + If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain + false + 4.13.2 + boolean + + + page + false + integer + + + pagesize + false + integer + + + port + Port + false + integer + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port the ldap server is running on + int + + + false + + + createRemoteAccessVpn + Creates a l2tp/ipsec remote access vpn + true + + + publicipid + public ip address id of the vpn server + true + uuid + + + account + an optional account for the VPN. Must be used with domainId. + false + string + + + domainid + an optional domainId for the VPN. If the account parameter is used, domainId must also be used. + false + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + iprange + the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server + false + string + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default + false + boolean + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + changeServiceForVirtualMachine + (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect. + false + + + id + The ID of the virtual machine + true + uuid + + + serviceofferingid + the service offering ID to apply to the virtual machine + true + uuid + + + automigrate + Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering + false + 4.17 + boolean + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + maxiops + New maximum number of IOPS for the custom disk offering + false + 4.17 + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + 4.17 + long + + + shrinkok + Verify OK to Shrink + false + 4.17 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + true + + + listTemplates + List all public, private, and privileged templates. + false + + + templatefilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + details + comma separated list of template details requested, value can be a list of [ all, min] + false + list + 4.15 + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + the template ID + false + uuid + + + ids + the IDs of the templates, mutually exclusive with id + false + list + 4.9 + list + + + imagestoreid + ID of the image or image cache store + false + 4.19 + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list VNF templates or not; true if need to list VNF templates, false otherwise. + false + 4.19.0 + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the template name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parenttemplateid + list datadisk templates by parent template id + false + 4.4 + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the templates + false + boolean + + + showremoved + show removed templates as well + false + boolean + + + showunique + If set to true, list only unique templates across zones + false + 4.13.2 + boolean + + + storageid + ID of the storage pool + false + 4.19 + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templatetype + the type of the template + false + 4.19.0 + string + + + zoneid + list templates by zoneId + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listGuestOsMapping + Lists all available OS mappings for given hypervisor + false + 4.4.0 + + + hypervisor + list Guest OS mapping by hypervisor + false + string + + + hypervisorversion + list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter + false + string + + + id + list mapping by its UUID + false + uuid + + + keyword + List by keyword + false + string + + + osdisplayname + list Guest OS mapping by OS display name + false + string + + + osnameforhypervisor + list Guest OS mapping by OS mapping name with hypervisor + false + string + + + ostypeid + list mapping by Guest OS Type UUID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + createTungstenFabricPolicy + create Tungsten-Fabric policy + true + + + name + Tungsten-Fabric policy name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createBucket + Creates a bucket in the specified object storage pool. + true + 4.19.0 + + + name + the name of the bucket + true + string + + + objectstorageid + Id of the Object Storage Pool where bucket is created + true + uuid + + + account + the account associated with the bucket. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain. + false + uuid + + + encryption + Enable bucket encryption + false + boolean + + + objectlocking + Enable object locking in bucket + false + boolean + + + policy + The Bucket access policy + false + string + + + projectid + the project associated with the bucket. Mutually exclusive with account parameter + false + uuid + + + quota + Bucket Quota in GB + false + integer + + + versioning + Enable bucket versioning + false + boolean + + + + + id + ID of the Bucket + string + + + accesskey + Bucket Access Key + string + + + account + the account associated with the Bucket + string + + + created + the date the Bucket was created + date + + + domain + the domain associated with the bucket + string + + + domainid + the ID of the domain associated with the bucket + string + + + domainpath + path of the domain to which the bucket belongs + 4.19.2.0 + string + + + encryption + Bucket Encryption + boolean + + + name + name of the Bucket + string + + + objectlocking + Bucket Object Locking + boolean + + + objectstorageid + id of the object storage hosting the Bucket; returned to admin user only + string + + + objectstore + Name of the object storage hosting the Bucket; returned to admin user only + string + + + policy + Bucket Access Policy + string + + + project + the project name of the bucket + string + + + projectid + the project id of the bucket + string + + + provider + Object storage provider + string + + + quota + Bucket Quota in GB + integer + + + size + Total size of objects in Bucket + long + + + state + State of the Bucket + string + + + url + Bucket URL + string + + + usersecretkey + Bucket Secret Key + string + + + versioning + Bucket Versioning + boolean + + + false + + + listPhysicalNetworks + Lists physical networks + false + 3.0.0 + + + id + list physical network by id + false + uuid + + + keyword + List by keyword + false + string + + + name + search by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the Zone ID for the physical network + false + uuid + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + deleteBrocadeVcsDevice + delete a Brocade VCS Switch + true + + + vcsdeviceid + Brocade Switch ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listFirewallRules + Lists all firewall rules for an IP address. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the firewall services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list firewall rules for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + extractIso + Extracts an ISO + true + + + id + the ID of the ISO file + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + url + the URL to which the ISO would be extracted + false + string + + + zoneid + the ID of the zone where the ISO is originally located + false + uuid + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + createAffinityGroup + Creates an affinity/anti-affinity group + true + + + name + name of the affinity group + true + string + + + type + Type of the affinity group from the available affinity/anti-affinity group types + true + string + + + account + an account for the affinity group. Must be used with domainId. + false + string + + + description + optional description of the affinity group + false + string + + + domainid + domainId of the account owning the affinity group + false + uuid + + + projectid + create affinity group for project + false + uuid + + + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + false + + + oauthlogin + Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired. + false + 4.19.0 + + + email + Email id with which user tried to login using OAuth provider + true + string + + + provider + Name of the provider + true + string + + + domain + Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed. + false + string + + + domainId + The id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precedence. + false + long + + + secretcode + Code that is provided by OAuth provider (Eg. google, github) after successful login + false + string + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + listInternalLoadBalancerElements + Lists all available Internal Load Balancer elements. + false + 4.2.0 + + + enabled + list internal load balancer elements by enabled state + false + boolean + + + id + list internal load balancer elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list internal load balancer elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + getHypervisorGuestOsNames + Gets the guest OS names in the hypervisor + true + 4.19.0 + + + hypervisor + Hypervisor type. One of : VMware, XenServer + true + string + + + hypervisorversion + Hypervisor version to get the guest os names (atleast one hypervisor host with the version specified must be available) + true + string + + + keyword + Keyword for guest os name + false + string + + + + + guestoscount + the guest OS count of the hypervisor + integer + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for guest os names + string + + + guestoslist(*) + the guest OS list of the hypervisor + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + list + + + false + + + createTungstenFabricProvider + Create Tungsten-Fabric provider in cloudstack + false + + + name + Tungsten-Fabric provider name + true + string + + + tungstengateway + Tungsten-Fabric provider gateway + true + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + true + string + + + zoneid + the ID of zone + true + uuid + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + false + string + + + tungstenproviderport + Tungsten-Fabric provider port + false + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + false + string + + + + + name + Tungsten-Fabric provider name + string + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + tungstengateway + Tungsten-Fabric provider gateway + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + string + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + string + + + tungstenproviderport + Tungsten-Fabric provider port + string + + + tungstenprovideruuid + Tungsten-Fabric provider uuid + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + enableHAForCluster + Enables HA cluster-wide + true + 4.11 + + + clusterid + ID of the cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + rebootVirtualMachine + Reboots a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + bootintosetup + Boot into hardware setup menu or not + false + 4.15.0.0 + boolean + + + forced + Force reboot the VM (VM is Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addVirtualMachinesToKubernetesCluster + Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters. + false + 4.19.0 + + + id + the ID of the Kubernetes cluster + true + uuid + + + virtualmachineids + the IDs of the VMs to add to the cluster + true + list + list + + + iscontrolnode + Is control node or not? Defaults to false. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricLogicalRouter + list Tungsten-Fabric logical router + false + + + keyword + List by keyword + false + string + + + logicalrouteruuid + the uuid of Tungsten-Fabric logical router + false + string + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listBackupOfferings + Lists backup offerings + false + 4.14.0 + + + id + The backup offering ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + The zone ID + false + uuid + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + addGuestOsMapping + Adds a guest OS name to hypervisor OS name mapping + true + 4.4.0 + + + hypervisor + Hypervisor type. One of : XenServer, KVM, VMWare + true + string + + + hypervisorversion + Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version + true + string + + + osnameforhypervisor + OS name specific to the hypervisor + true + string + + + forced + Forces add user defined guest os mapping, overrides any existing user defined mapping + false + 4.19.0 + boolean + + + osdisplayname + Display Name of Guest OS standard type. Either Display Name or UUID must be passed + false + string + + + osmappingcheckenabled + When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.) + false + 4.19.0 + boolean + + + ostypeid + UUID of Guest OS type. Either the UUID or Display Name must be passed + false + uuid + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + listVnfTemplates + List all public, private, and privileged VNF templates. + false + 4.19.0 + + + templatefilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + details + comma separated list of template details requested, value can be a list of [ all, min] + false + list + 4.15 + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + the template ID + false + uuid + + + ids + the IDs of the templates, mutually exclusive with id + false + list + 4.9 + list + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list VNF templates or not; true if need to list VNF templates, false otherwise. + false + 4.19.0 + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the template name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parenttemplateid + list datadisk templates by parent template id + false + 4.4 + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the templates + false + boolean + + + showremoved + show removed templates as well + false + boolean + + + showunique + If set to true, list only unique templates across zones + false + 4.13.2 + boolean + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templatetype + the type of the template + false + 4.19.0 + string + + + zoneid + list templates by zoneId + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deployVnfAppliance + Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template. + true + 4.19.0 + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter + false + list + list + + + bootintosetup + Boot into hardware setup or not (ignored if startVm = false, only valid for vmware) + false + 4.15.0.0 + boolean + + + bootmode + Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + boottype + Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + copyimagetags + if true the image tags (if any) will be copied to the VM, default value is false + false + 4.13 + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter + false + map + 4.11 + map + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + details + used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details + false + map + 4.3 + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + diskofferingid + the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created. + false + uuid + + + displayname + an optional user generated name for the virtual machine + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + 4.2 + boolean + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain. + false + uuid + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable + false + 4.16 + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + an optional group for the virtual machine + false + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + uuid + + + hypervisor + the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call + false + string + + + iodriverpolicy + Controls specific policies on IO + false + string + + + iothreadsenabled + IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs. + false + boolean + + + ip6address + the ipv6 address for default vm's network + false + string + + + ipaddress + the ip address for default vm's network + false + string + + + iptonetworklist + ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid + false + map + map + + + keyboard + an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us + false + string + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs used to login to the virtual machine + false + list + 4.17 + list + + + macaddress + the mac address for default vm's network + false + string + + + name + host name for the virtual machine + false + string + + + networkids + list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter + false + list + list + + + nicmultiqueuenumber + The number of queues for multiqueue NICs. + false + 4.18 + integer + + + nicnetworklist + VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid + false + map + 4.15 + map + + + nicpackedvirtqueuesenabled + Enable packed virtqueues or not. + false + 4.18 + boolean + + + overridediskofferingid + the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id + false + 4.17 + uuid + + + password + The password of the virtual machine. If null, a random password will be generated for the VM. + false + 4.19.0.0 + string + + + projectid + Deploy vm for the project + false + uuid + + + properties + used to specify the vApp properties. + false + map + 4.15 + map + + + rootdisksize + Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.4 + long + + + securitygroupids + comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + size + the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId + false + long + + + startvm + true if start vm after creating; defaulted to true if not specified + false + boolean + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the Userdata + false + 4.18 + uuid + + + vnfcidrlist + the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0. + false + list + list + + + vnfconfiguremanagement + True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups. + false + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateNetworkOffering + Updates a network offering. + false + + + availability + the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required + false + string + + + displaytext + the display text of the network offering + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + id + the id of the network offering + false + uuid + + + keepaliveenabled + if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file. + false + boolean + + + maxconnections + maximum number of concurrent connections supported by the network offering + false + integer + + + name + the name of the network offering + false + string + + + sortkey + sort key of the network offering, integer + false + integer + + + state + update state for the network offering + false + string + + + tags + the tags for the network offering. + false + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + changeOutOfBandManagementPassword + Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + password + the new host management interface password of maximum length 16, if none is provided a random password would be used + false + string + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listResourceDetails + List resource detail(s) + false + 4.2 + + + resourcetype + list by resource type + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + if set to true, only details marked with display=true, are returned. False by default + false + 4.3 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + key + list by key + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + list by resource id + false + string + + + value + list by key, value. Needs to be passed only along with key + false + 4.4 + string + + + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + false + + + createNetworkOffering + Creates a network offering. + false + 3.0.0 + + + guestiptype + guest type of the network offering: Shared or Isolated + true + string + + + name + the name of the network offering + true + string + + + traffictype + the traffic type for the network offering. Supported type in current release is GUEST only + true + string + + + availability + the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks + false + string + + + conservemode + true if the network offering is IP conserve mode enabled + false + boolean + + + details + Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup + false + map + 4.2.0 + map + + + displaytext + the display text of the network offering, defaults to the value of 'name'. + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + false + boolean + + + enable + set to true if the offering is to be enabled during creation. Default is false + false + 4.16 + boolean + + + fortungsten + true if network offering is meant to be used for Tungsten-Fabric, false otherwise. + false + boolean + + + forvpc + true if network offering is meant to be used for VPC, false otherwise. + false + boolean + + + internetprotocol + The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6 + false + 4.17.0 + string + + + ispersistent + true if network offering supports persistent networks; defaulted to false if not specified + false + boolean + + + keepaliveenabled + if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file. + false + boolean + + + maxconnections + maximum number of concurrent connections supported by the network offering + false + integer + + + networkrate + data transfer rate in megabits per second allowed + false + integer + + + servicecapabilitylist + desired service capabilities as part of network offering + false + map + map + + + serviceofferingid + the service offering ID used by virtual router provider + false + uuid + + + serviceproviderlist + provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network + false + map + map + + + specifyipranges + true if network offering supports specifying ip ranges; defaulted to false if not specified + false + boolean + + + specifyvlan + true if network offering supports vlans + false + boolean + + + supportedservices + services supported by the network offering + false + list + list + + + tags + the tags for the network offering. + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + dedicateCluster + Dedicate an existing cluster + true + + + clusterid + the ID of the Cluster + true + uuid + + + domainid + the ID of the containing domain + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the cluster + string + + + affinitygroupid + the Dedication Affinity Group ID of the cluster + string + + + clusterid + the ID of the cluster + string + + + clustername + the name of the cluster + string + + + domainid + the domain ID of the cluster + string + + + false + + + createIpForwardingRule + Creates an IP forwarding rule + true + + + ipaddressid + the public IP address ID of the forwarding rule, already associated via associateIp + true + uuid + + + protocol + the protocol for the rule. Valid values are TCP or UDP. + true + string + + + startport + the start port for the rule + true + integer + + + cidrlist + the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use. + false + list + list + + + endport + the end port for the rule + false + integer + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default + false + boolean + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listElastistorInterface + Lists the network Interfaces of elastistor + false + + + controllerid + controller id + false + string + + + + + id + the id of the volume + string + + + compression + compression + string + + + deduplication + deduplication + string + + + graceallowed + graceallowed + string + + + name + the name of the volume + string + + + sync + synchronization + string + + + false + + + quotaStatement + Create a quota statement + false + 4.7.0 + + + account + Optional, Account Id for which statement needs to be generated + true + string + + + domainid + Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain. + true + uuid + + + enddate + End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + true + date + + + startdate + Start date range quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + true + date + + + accountid + List usage records for the specified account + false + uuid + + + type + List quota usage records for the specified usage type + false + integer + + + + + account + account name + string + + + accountid + account id + long + + + domain + domain id + long + + + name + usage type name + string + + + quota + quota consumed + bigdecimal + + + type + usage type + int + + + unit + usage unit + string + + + false + + + updateLBStickinessPolicy + Updates load balancer stickiness policy + true + 4.4 + + + id + id of lb stickiness policy + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + listPods + Lists all Pods. + false + + + allocationstate + list pods by allocation state + false + string + + + id + list Pods by ID + false + uuid + + + keyword + List by keyword + false + string + + + name + list Pods by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the pods + false + boolean + + + zoneid + list Pods by Zone ID + false + uuid + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + deleteTungstenFabricAddressGroup + delete Tungsten-Fabric address group + true + + + addressgroupuuid + the uuid of Tungsten-Fabric address group + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaTariffList + Lists all quota tariff plans + false + 4.7.0 + + + enddate + The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2021-11-03. + false + 4.18.0.0 + date + + + keyword + List by keyword + false + string + + + listall + False will list only not removed quota tariffs. If set to True, we will list all, including the removed ones. The default is false. + false + 4.18.0.0 + boolean + + + name + The name of the quota tariff. + false + 4.18.0.0 + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + The start date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + usagetype + Usage type of the resource + false + integer + + + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + uuid + uuid + string + + + false + + + stopKubernetesCluster + Stops a running CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSnapshots + Lists all available snapshots for the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + lists snapshot by snapshot ID + false + uuid + + + ids + the IDs of the snapshots, mutually exclusive with id + false + list + 4.9 + list + + + imagestoreid + ID of the image or image cache store + false + 4.19 + uuid + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY. + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + locationtype + list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty + false + 4.19.0 + string + + + name + lists snapshot by snapshot name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showunique + If set to false, list templates across zones and their storages + false + 4.19.0 + boolean + + + snapshottype + valid values are MANUAL or RECURRING. + false + string + + + storageid + ID of the storage pool + false + 4.19 + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + volumeid + the ID of the disk volume + false + uuid + + + zoneid + list snapshots by zone id + false + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addAccountToProject + Adds account to a project + true + 3.0.0 + + + projectid + ID of the project to add the account to + true + uuid + + + account + name of the account to be added to the project + false + string + + + email + email to which invitation to the project is going to be sent + false + string + + + projectroleid + ID of the project role + false + uuid + + + roletype + Project role type to be assigned to the user - Admin/Regular; default: Regular + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateResourceToAnotherSecondaryStorage + migrates resources from one secondary storage to destination image store + true + 4.19.0 + + + destpool + id of the destination secondary storage pool to which the resources are to be migrated + true + uuid + + + srcpool + id of the image store from where the data is to be migrated + true + uuid + + + snapshots + id(s) of the snapshots to be migrated + false + list + list + + + templates + id(s) of the templates to be migrated + false + list + list + + + + + message + Response message from migration of secondary storage data objects + string + + + migrationtype + Type of migration requested for + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSSHKeyPair + Deletes a keypair by name + false + + + name + Name of the keypair + true + string + + + account + the account associated with the keypair. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the keypair + false + uuid + + + projectid + the project associated with keypair + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + searchLdap + Searches LDAP based on the username attribute + false + 4.2.0 + + + query + query to search using + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + readyForShutdown + Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown + false + 4.19.0 + + + managementserverid + the uuid of the management server + false + uuid + + + + + managementserverid + The id of the management server + string + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + createTungstenFabricLogicalRouter + create Tungsten-Fabric logical router + true + + + name + Tungsten-Fabric logical router name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createTungstenFabricFirewallRule + create Tungsten-Fabric firewall + true + + + action + Tungsten-Fabric firewall rule action + true + string + + + direction + Tungsten-Fabric firewall rule direction + true + string + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + true + string + + + name + Tungsten-Fabric firewall rule name + true + string + + + sequence + the sequence of Tungsten-Fabric firewall rule + true + integer + + + servicegroupuuid + Tungsten-Fabric firewall rule service group uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + destaddressgroupuuid + Tungsten-Fabric firewall rule destination address group uuid + false + string + + + destnetworkuuid + the uuid of Tungsten-Fabric destination network + false + string + + + desttaguuid + Tungsten-Fabric firewall rule destination tag uuid + false + string + + + srcaddressgroupuuid + Tungsten-Fabric firewall rule source address group uuid + false + string + + + srcnetworkuuid + the uuid of Tungsten-Fabric source network + false + string + + + srctaguuid + Tungsten-Fabric firewall rule source tag uuid + false + string + + + tagtypeuuid + Tungsten-Fabric firewall rule tag type uuid + false + string + + + + + action + Tungsten-Fabric firewall rule action + string + + + destaddressgroup + Tungsten-Fabric firewall rule destination address group + string + + + destnetwork + Tungsten-Fabric firewall rule destination network + string + + + desttag + Tungsten-Fabric firewall rule destination tag + string + + + direction + Tungsten-Fabric firewall rule direction + string + + + name + Tungsten-Fabric firewall rule name + string + + + servicegroup + Tungsten-Fabric firewall rule service group + string + + + srcaddressgroup + Tungsten-Fabric firewall rule source address group + string + + + srcnetwork + Tungsten-Fabric firewall rule source network + string + + + srctag + Tungsten-Fabric firewall rule source tag + string + + + tagtype + Tungsten-Fabric firewall rule tag type + string + + + uuid + Tungsten-Fabric firewall rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listConfigurations + Lists all configurations. + false + + + accountid + the ID of the Account to update the parameter value for corresponding account + false + uuid + + + category + lists configurations by category + false + string + + + clusterid + the ID of the Cluster to update the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to update the parameter value for corresponding domain + false + uuid + + + group + lists configuration by group name (primarily used for UI) + false + 4.18.0 + string + + + imagestoreuuid + the ID of the Image Store to update the parameter value for corresponding image store + false + uuid + + + keyword + List by keyword + false + string + + + name + lists configuration by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parent + lists configuration by parent name (primarily used for UI) + false + 4.18.0 + string + + + storageid + the ID of the Storage pool to update the parameter value for corresponding storage pool + false + uuid + + + subgroup + lists configuration by subgroup name (primarily used for UI) + false + 4.18.0 + string + + + zoneid + the ID of the Zone to update the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + stopNetScalerVpx + Stops a NetScalervm. + true + + + id + the ID of the NetScaler vm + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + scaleKubernetesCluster + Scales a created, running or stopped CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + false + boolean + + + maxsize + Maximum number of worker nodes in the cluster + false + long + + + minsize + Minimum number of worker nodes in the cluster + false + long + + + nodeids + the IDs of the nodes to be removed + false + list + list + + + serviceofferingid + the ID of the service offering for the virtual machines in the cluster. + false + uuid + + + size + number of Kubernetes cluster nodes + false + long + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + deleteInstanceGroup + Deletes a vm group + false + + + id + the ID of the instance group + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateTrafficType + Updates traffic type of a physical network + true + 3.0.0 + + + id + traffic type id + true + uuid + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a Hyperv host + false + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + false + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + false + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + false + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + false + string + + + + + id + id of the network provider + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a HyperV host + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + string + + + physicalnetworkid + the physical network this belongs to + string + + + traffictype + the trafficType to be added to the physical network + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + string + + + false + + + listConditions + List Conditions for VM auto scaling + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + counterid + Counter-id of the condition. + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + ID of the Condition. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + policyid + the ID of the policy + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the id of the Condition + string + + + account + the owner of the Condition. + string + + + counter + Details of the Counter. + counterresponse + + + counterid + the Id of the Counter. + string + + + countername + the Name of the Counter. + string + + + domain + the domain name of the owner. + string + + + domainid + the domain id of the Condition owner + string + + + domainpath + path of the domain to which the Condition owner belongs + 4.19.2.0 + string + + + project + the project name of the Condition + string + + + projectid + the project id of the Condition. + string + + + relationaloperator + Relational Operator to be used with threshold. + string + + + threshold + Threshold Value for the counter. + long + + + zoneid + zone id of counter + string + + + false + + + migrateSecondaryStorageData + migrates data objects from one secondary storage to destination image store(s) + true + 4.15.0 + + + destpools + id(s) of the destination secondary storage pool(s) to which the templates are to be migrated + true + list + list + + + srcpool + id of the image store from where the data is to be migrated + true + uuid + + + migrationtype + Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete + false + string + + + + + message + Response message from migration of secondary storage data objects + string + + + migrationtype + Type of migration requested for + string + + + success + true if operation is executed successfully + boolean + + + false + + + destroyVolume + Destroys a Volume. + true + 4.14.0 + + + id + The ID of the volume + true + uuid + + + expunge + If true is passed, the volume is expunged immediately. False by default. + false + 4.6.0 + boolean + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addTrafficType + Adds traffic type to a physical network + true + 3.0.0 + + + physicalnetworkid + the Physical Network ID + true + uuid + + + traffictype + the trafficType to be added to the physical network + true + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a Hyperv host + false + string + + + isolationmethod + Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'. + false + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + false + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + false + string + + + vlan + The VLAN id to be used for Management traffic by VMware host + false + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + false + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + false + string + + + + + id + id of the network provider + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a HyperV host + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + string + + + physicalnetworkid + the physical network this belongs to + string + + + traffictype + the trafficType to be added to the physical network + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + string + + + false + + + listSecondaryStorageSelectors + Lists the secondary storage selectors and their rules. + false + 4.19.0 + + + zoneid + The zone ID to be used in the search filter. + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + showremoved + Show removed heuristics. + false + boolean + + + type + Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + false + string + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + listLoadBalancerRuleInstances + List all virtual machine instances that are assigned to a load balancer rule. + false + + + id + the ID of the load balancer rule + true + uuid + + + applied + true if listing all virtual machines currently applied to the load balancer rule; default is true + false + boolean + + + keyword + List by keyword + false + string + + + lbvmips + true if load balancer rule VM IP information to be included; default is false + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + + + lbvmipaddresses + IP addresses of the vm set of lb rule + list + + + loadbalancerruleinstance + the user vm set for lb rule + uservmresponse + + + false + + + deleteCondition + Removes a condition for VM auto scaling + true + + + id + the ID of the condition. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updatePhysicalNetwork + Updates a physical network + true + 3.0.0 + + + id + physical network id + true + uuid + + + networkspeed + the speed for the physical network[1G/10G] + false + string + + + state + Enabled/Disabled + false + string + + + tags + Tag the physical network + false + list + list + + + vlan + the VLAN for the physical network + false + string + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + createTungstenFabricManagementNetwork + create Tungsten-Fabric management network + false + + + podid + the ID of pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricFirewallRule + list Tungsten-Fabric firewall rule + false + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + false + string + + + firewallruleuuid + the uuid of Tungsten-Fabric firewall rule + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + action + Tungsten-Fabric firewall rule action + string + + + destaddressgroup + Tungsten-Fabric firewall rule destination address group + string + + + destnetwork + Tungsten-Fabric firewall rule destination network + string + + + desttag + Tungsten-Fabric firewall rule destination tag + string + + + direction + Tungsten-Fabric firewall rule direction + string + + + name + Tungsten-Fabric firewall rule name + string + + + servicegroup + Tungsten-Fabric firewall rule service group + string + + + srcaddressgroup + Tungsten-Fabric firewall rule source address group + string + + + srcnetwork + Tungsten-Fabric firewall rule source network + string + + + srctag + Tungsten-Fabric firewall rule source tag + string + + + tagtype + Tungsten-Fabric firewall rule tag type + string + + + uuid + Tungsten-Fabric firewall rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createProject + Creates a project + true + 3.0.0 + + + name + name of the project + true + string + + + account + account who will be Admin for the project + false + string + + + accountid + ID of the account owning a project + false + uuid + + + displaytext + The display text of the project, defaults to the 'name´. + false + string + + + domainid + domain ID of the account owning a project + false + uuid + + + userid + user ID of the account to be assigned as owner of the project i.e., Project Admin + false + 4.15.0 + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + assignCertToLoadBalancer + Assigns a certificate to a load balancer rule + true + + + certid + the ID of the certificate + true + uuid + + + lbruleid + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addCiscoVnmcResource + Adds a Cisco Vnmc Controller + false + + + hostname + Hostname or ip address of the Cisco VNMC Controller. + true + string + + + password + Credentials to access the Cisco VNMC Controller API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Credentials to access the Cisco VNMC Controller API + true + string + + + + false + + + markDefaultZoneForAccount + Marks a default zone for this account + true + 4.0 + + + account + Name of the account that is to be marked. + true + string + + + domainid + Marks the account that belongs to the specified domain. + true + uuid + + + zoneid + The Zone ID with which the account is to be marked. + true + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + revokeCertificate + Revokes certificate using configured CA plugin + true + 4.11.0 + + + serial + The certificate serial number, as a hex value + true + string + + + cn + The certificate CN + false + string + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + changeServiceForSystemVm + Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect. + false + + + id + The ID of the system vm + true + uuid + + + serviceofferingid + the service offering ID to apply to the system vm + true + uuid + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + updateSiocInfo + Update SIOC info + false + 4.11.0 + + + iopsnotifythreshold + Notify if IOPS above this value + true + integer + + + limitiopspergb + Limit IOPS per GB + true + integer + + + sharespergb + Shares per GB + true + integer + + + storageid + Storage Pool ID + true + uuid + + + zoneid + Zone ID + true + uuid + + + + + msg + The return message from the operation ('Success' if successful) + string + + + false + + + cloudianSsoLogin + Generates single-sign-on login url for logged-in CloudStack user to access the Cloudian Management Console + false + 4.11.0 + + + + url + the sso redirect url + string + + + false + + + deleteVMSnapshot + Deletes a vmsnapshot. + true + 4.2.0 + + + vmsnapshotid + The ID of the VM snapshot + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + unmanageVirtualMachine + Unmanage a guest virtual machine. + true + 4.15.0 + + + id + The ID of the virtual machine to unmanage + true + uuid + + + + + details + details of the unmanage VM operation + string + + + success + result of the unmanage VM operation + boolean + + + false + + + rebootRouter + Starts a router. + true + + + id + the ID of the router + true + uuid + + + forced + Force reboot the router (Router is force Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listNics + list the vm nics IP to NIC + false + + + virtualmachineid + the ID of the vm + true + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + keyword + List by keyword + false + string + + + networkid + list nic of the specific vm's network + false + uuid + + + nicid + the ID of the nic to list IPs + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + false + + + createSnapshotFromVMSnapshot + Creates an instant snapshot of a volume from existing vm snapshot. + true + 4.10.0 + + + vmsnapshotid + The ID of the VM snapshot + true + uuid + + + volumeid + The ID of the disk volume + true + uuid + + + name + the name of the snapshot + false + string + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listImageStoreObjects + Lists objects at specified path on an image store. + false + 4.19.0 + + + id + id of the image store + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + path to list on image store + false + string + + + + + format + Format of template associated with the data store object. + string + + + isdirectory + Is it a directory. + boolean + + + lastupdated + Last modified date of the file/directory. + date + + + name + Name of the data store object. + string + + + size + Size is in Bytes. + long + + + snapshotid + Snapshot ID associated with the data store object. + string + + + templateid + Template ID associated with the data store object. + string + + + volumeid + Volume ID associated with the data store object. + string + + + false + + + dedicateGuestVlanRange + Dedicates a guest vlan range to an account + false + + + physicalnetworkid + physical network ID of the vlan + true + uuid + + + vlanrange + guest vlan range to be dedicated + true + string + + + account + account who will own the VLAN + false + string + + + domainid + domain ID of the account owning a VLAN + false + uuid + + + projectid + project who will own the VLAN + false + uuid + + + + + id + the ID of the guest VLAN range + string + + + account + the account of the guest VLAN range + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + domainpath + path of the domain to which the guest VLAN range belongs + 4.19.2.0 + string + + + guestvlanrange + the guest VLAN range + string + + + physicalnetworkid + the physical network of the guest vlan range + long + + + project + the project name of the guest vlan range + string + + + projectid + the project id of the guest vlan range + string + + + zoneid + the zone of the guest vlan range + long + + + false + + + updateIso + Updates an ISO file. + false + + + id + the ID of the image file + true + uuid + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteCounter + Deletes a counter for VM auto scaling + true + + + id + the ID of the counter + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + issueCertificate + Issues a client certificate using configured or provided CA plugin + true + 4.11.0 + + + csr + The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered + false + string + + + domain + Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN + false + string + + + duration + Certificate validity duration in number of days, when not provided the default configured value will be used + false + integer + + + ipaddress + Comma separated list of IP addresses, the certificate should be issued for + false + string + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + cacertificates + The CA certificate(s) + string + + + certificate + The client certificate + string + + + privatekey + Private key for the certificate + string + + + false + + + createPortForwardingRule + Creates a port forwarding rule + true + + + ipaddressid + the IP address id of the port forwarding rule + true + uuid + + + privateport + the starting port of port forwarding rule's private port range + true + integer + + + protocol + the protocol for the port forwarding rule. Valid values are TCP or UDP. + true + string + + + publicport + the starting port of port forwarding rule's public port range + true + integer + + + virtualmachineid + the ID of the virtual machine for the port forwarding rule + true + uuid + + + cidrlist + the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed. + false + list + list + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + networkid + the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case). + false + uuid + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true + false + boolean + + + privateendport + the ending port of port forwarding rule's private port range + false + integer + + + publicendport + the ending port of port forwarding rule's private port range + false + integer + + + vmguestip + VM guest nic secondary IP address for the port forwarding rule + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + dedicateZone + Dedicates a zones. + true + + + domainid + the ID of the containing domain + true + uuid + + + zoneid + the ID of the zone + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Zone is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the zone + string + + + domainid + the domain ID to which the Zone is dedicated + string + + + zoneid + the ID of the Zone + string + + + zonename + the Name of the Zone + string + + + false + + + prepareTemplate + load template into primary storage + false + + + templateid + template ID of the template to be prepared in primary storage(s). + true + uuid + + + zoneid + zone ID of the template to be prepared in primary storage(s). + true + uuid + + + storageid + storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateBackupOffering + Updates a backup offering. + false + 4.16.0 + + + id + The ID of the Backup Offering to be updated + true + uuid + + + allowuserdrivenbackups + Whether to allow user driven backups or not + false + boolean + + + description + The description of the Backup Offering to be updated + false + string + + + name + The name of the Backup Offering to be updated + false + string + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + listBuckets + Lists all Buckets. + false + 4.19.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the bucket + false + uuid + + + ids + the IDs of the Buckets, mutually exclusive with id + false + list + list + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the bucket + false + string + + + objectstorageid + the ID of the object storage pool, available to ROOT admin only + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + ID of the Bucket + string + + + accesskey + Bucket Access Key + string + + + account + the account associated with the Bucket + string + + + created + the date the Bucket was created + date + + + domain + the domain associated with the bucket + string + + + domainid + the ID of the domain associated with the bucket + string + + + domainpath + path of the domain to which the bucket belongs + 4.19.2.0 + string + + + encryption + Bucket Encryption + boolean + + + name + name of the Bucket + string + + + objectlocking + Bucket Object Locking + boolean + + + objectstorageid + id of the object storage hosting the Bucket; returned to admin user only + string + + + objectstore + Name of the object storage hosting the Bucket; returned to admin user only + string + + + policy + Bucket Access Policy + string + + + project + the project name of the bucket + string + + + projectid + the project id of the bucket + string + + + provider + Object storage provider + string + + + quota + Bucket Quota in GB + integer + + + size + Total size of objects in Bucket + long + + + state + State of the Bucket + string + + + url + Bucket URL + string + + + usersecretkey + Bucket Secret Key + string + + + versioning + Bucket Versioning + boolean + + + false + + + stopInternalLoadBalancerVM + Stops an Internal LB vm. + true + + + id + the ID of the internal lb vm + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateSecurityGroup + Updates a security group + false + 4.14.0.0 + + + id + The ID of the security group. + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + name + The new name of the security group. + false + string + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + samlSso + SP initiated SAML Single Sign On + false + + + idpid + Identity Provider Entity ID + true + string + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + createDomain + Creates a domain + false + + + name + creates domain with this name + true + string + + + domainid + Domain UUID, required for adding domain from another Region + false + string + + + networkdomain + Network domain for networks in the domain + false + string + + + parentdomainid + assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed. + false + uuid + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + addImageStore + Adds backup image store. + false + 4.2.0 + + + provider + the image store provider name + true + string + + + details + the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + name + the name for the image store + false + string + + + url + the URL for the image store + false + string + + + zoneid + the Zone ID for the image store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + revokeTemplateDirectDownloadCertificate + Revoke a direct download certificate from hosts in a zone + false + 4.13 + + + zoneid + (optional) zone to revoke certificate + true + uuid + + + hostid + (optional) the host ID to revoke certificate + false + uuid + + + hypervisor + (optional) hypervisor type + false + string + + + id + id of the certificate + false + uuid + + + name + (optional) alias of the SSL certificate + false + string + + + + + details + indicates the details in case of failure or host skipped + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + status + indicates if the certificate has been revoked from the host, failed or skipped + string + + + false + + + updateStorageCapabilities + Syncs capabilities of storage pools + false + 4.16.0 + + + id + Storage pool id + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteUserData + Deletes a userdata + false + 4.18 + + + id + the ID of the Userdata + true + uuid + + + account + an optional account for the userdata. Must be used with domainId. + false + string + + + domainid + an optional domainId for the userdata. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the userdata + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + assignVolume + Changes ownership of a Volume from one account to another. + false + 4.18.0.0 + + + volumeid + The ID of the volume to be reassigned. + true + uuid + + + accountid + The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'. + false + uuid + + + projectid + The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'. + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listSupportedNetworkServices + Lists all network services provided by CloudStack or for the given Provider. + false + 3.0.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + network service provider name + false + string + + + service + network service name to list providers and capabilities of + false + string + + + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + false + + + revokeSecurityGroupIngress + Deletes a particular ingress rule from this security group + true + + + id + The ID of the ingress rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addNetworkServiceProvider + Adds a network serviceProvider to a physical network + true + 3.0.0 + + + name + the name for the physical network service provider + true + string + + + physicalnetworkid + the Physical Network ID to add the provider to + true + uuid + + + destinationphysicalnetworkid + the destination Physical Network ID to bridge to + false + uuid + + + servicelist + the list of services to be enabled for this physical network service provider + false + list + list + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + quotaTariffDelete + Marks a quota tariff as removed. + false + 4.18.0.0 + + + id + ID of the quota tariff + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVpnGateway + Delete site to site vpn gateway + true + + + id + id of customer gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createServiceOffering + Creates a service offering. + false + + + name + the name of the service offering + true + string + + + bytesreadrate + bytes read rate of the disk offering + false + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + long + + + byteswriterate + bytes write rate of the disk offering + false + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + long + + + cachemode + the cache mode to use for this disk offering. none, writeback or writethrough + false + 4.14 + string + + + cpunumber + the CPU number of the service offering + false + integer + + + cpuspeed + For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz. +For the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning. + false + integer + + + customized + Whether service offering size is custom or not + false + 4.13 + boolean + + + customizediops + whether compute offering iops is custom or not + false + 4.4 + boolean + + + deploymentplanner + The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used + false + string + + + diskofferingid + the ID of the disk offering to which service offering should be mapped + false + 4.17 + uuid + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + false + 4.17 + boolean + + + displaytext + The display text of the service offering, defaults to 'name'. + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + false + 4.16 + boolean + + + encryptroot + VMs using this offering require root volume encryption + false + 4.18 + boolean + + + hosttags + the host tag for this service offering. + false + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + false + 4.4 + integer + + + iopsreadrate + io requests read rate of the disk offering + false + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + long + + + iopswriterate + io requests write rate of the disk offering + false + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + long + + + issystem + is this a system vm offering + false + boolean + + + isvolatile + true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM + false + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + false + boolean + + + maxcpunumber + The maximum number of CPUs to be set with Custom Computer Offering + false + 4.13 + integer + + + maxiops + max iops of the compute offering + false + 4.4 + long + + + maxmemory + The maximum memory size of the custom service offering in MB + false + 4.13 + integer + + + memory + the total memory of the service offering in MB + false + integer + + + mincpunumber + The minimum number of CPUs to be set with Custom Computer Offering + false + 4.13 + integer + + + miniops + min iops of the compute offering + false + 4.4 + long + + + minmemory + The minimum memory size of the custom service offering in MB + false + 4.13 + integer + + + networkrate + data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtype + false + integer + + + offerha + the HA for the service offering + false + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + false + string + + + rootdisksize + the Root disk size in GB. + false + 4.15 + long + + + serviceofferingdetails + details for planner, used to store specific parameters + false + map + map + + + storagepolicy + Name of the storage policy defined at vCenter, this is applicable only for VMware + false + 4.15 + uuid + + + storagetype + the storage type of the service offering. Values are local and shared. + false + string + + + systemvmtype + the system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm". + false + string + + + tags + the tags for this service offering. + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + state + state of the service offering + string + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + assignVirtualMachine + Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain. + false + 3.0.0 + + + virtualmachineid + id of the VM to be moved + true + uuid + + + account + account name of the new VM owner. + false + string + + + domainid + domain id of the new VM owner. + false + uuid + + + networkids + list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created. + false + list + list + + + projectid + an optional project for the new VM owner. + false + uuid + + + securitygroupids + list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group. + false + list + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVmsForImport + Lists virtual machines on a unmanaged host + false + 4.19.0 + + + host + the host name or IP address + true + string + + + hypervisor + hypervisor type of the host + true + string + + + zoneid + the zone ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + password + the password for the host + false + string + + + username + the username for the host + false + string + + + + + bootmode + indicates the boot mode + string + + + boottype + indicates the boot type + string + + + clusterid + the ID of the cluster to which virtual machine belongs + string + + + clustername + the name of the cluster to which virtual machine belongs + string + + + cpucorepersocket + the CPU cores per socket for the virtual machine. VMware specific + integer + + + cpunumber + the CPU cores of the virtual machine + integer + + + cpuspeed + the CPU speed of the virtual machine + integer + + + hostid + the ID of the host to which virtual machine belongs + string + + + hostname + the name of the host to which virtual machine belongs + string + + + memory + the memory of the virtual machine in MB + integer + + + name + the name of the virtual machine + string + + + osdisplayname + the operating system of the virtual machine + string + + + osid + the operating system ID of the virtual machine + string + + + powerstate + the power state of the virtual machine + string + + + disk(*) + the list of disks associated with the virtual machine + + + id + the ID of the disk + string + + + capacity + the capacity of the disk in bytes + long + + + controller + the controller of the disk + string + + + controllerunit + the controller unit of the disk + integer + + + datastorehost + the controller of the disk + string + + + datastorename + the controller of the disk + string + + + datastorepath + the controller of the disk + string + + + datastoretype + the controller of the disk + string + + + imagepath + the file path of the disk image + string + + + label + the label of the disk + string + + + position + the position of the disk + integer + + + set + + + nic(*) + the list of nics associated with the virtual machine + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + configureNetscalerLoadBalancer + configures a netscaler load balancer device + true + + + lbdeviceid + Netscaler load balancer device ID + true + uuid + + + inline + true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall + false + boolean + + + lbdevicecapacity + capacity of the device, Capacity will be interpreted as number of networks device can handle + false + long + + + lbdevicededicated + true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts + false + boolean + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + false + list + list + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + deleteTungstenFabricServiceGroup + delete Tungsten-Fabric service group + true + + + servicegroupuuid + the uuid of Tungsten-Fabric service group + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addObjectStoragePool + Adds a object storage pool + false + 4.19.0 + + + name + the name for the object store + true + string + + + provider + the object store provider name + true + string + + + url + the URL for the object store + true + string + + + details + the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + tags + the tags for the storage pool + false + string + + + + + id + the ID of the object store + string + + + name + the name of the object store + string + + + providername + the provider name of the object store + string + + + storagetotal + the total size of the object store + long + + + storageused + the object store currently used size + long + + + url + the url of the object store + string + + + false + + + deleteUserFromProject + Deletes user from the project + true + 4.15.0 + + + projectid + ID of the project to remove the user from + true + uuid + + + userid + Id of the user to be removed from the project + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkServiceProvider + Deletes a Network Service Provider. + true + 3.0.0 + + + id + the ID of the network service provider + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkDevice + List network devices + false + + + keyword + List by keyword + false + string + + + networkdeviceparameterlist + parameters for network device + false + map + map + + + networkdevicetype + Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the network device + string + + + false + + + listProjectRoles + Lists Project roles in CloudStack + false + 4.15.0 + + + projectid + List project role by project ID. + true + uuid + + + keyword + List by keyword + false + string + + + name + List project role by project role name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectroleid + List project role by project role ID. + false + uuid + + + + + projectid + the id of the project + string + + + false + + + deleteOpenDaylightController + Removes an OpenDyalight controler + true + + + id + OpenDaylight Controller ID + true + uuid + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + updateTemplate + Updates attributes of a template. + false + + + id + the ID of the image file + true + uuid + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + string + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateVpnConnection + Updates site to site vpn connection + true + 4.4 + + + id + id of vpn connection + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + createVlanIpRange + Creates a VLAN IP range. + false + + + account + account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted + false + string + + + domainid + domain ID of the account owning a VLAN + false + uuid + + + endip + the ending IP address in the VLAN IP range + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + forsystemvms + true if IP range is set to system vms, false if not + false + boolean + + + forvirtualnetwork + true if VLAN is of Virtual type, false if Direct + false + boolean + + + gateway + the gateway of the VLAN IP range + false + string + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6gateway + the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC + false + string + + + netmask + the netmask of the VLAN IP range + false + string + + + networkid + the network id + false + uuid + + + physicalnetworkid + the physical network id + false + uuid + + + podid + optional parameter. Have to be specified for Direct Untagged vlan only. + false + uuid + + + projectid + project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted + false + uuid + + + startip + the beginning IP address in the VLAN IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + vlan + the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged + false + string + + + zoneid + the Zone ID of the VLAN IP range + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + listPaloAltoFirewallNetworks + lists network that are using Palo Alto firewall device + false + + + lbdeviceid + palo alto balancer device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getPathForVolume + Get the path associated with the provided volume UUID + false + + + volumeid + CloudStack Volume UUID + true + string + + + + + path + The path field for the volume + string + + + false + + + listManagementServers + Lists management servers. + false + + + id + the id of the management server + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the management server + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the management server + string + + + javadistribution + the java distribution name running the management server process + string + + + javaversion + the version of the java distribution running the management server process + string + + + kernelversion + the running OS kernel version for this Management Server + string + + + lastboottime + the last time the host on which this Management Server runs was booted + date + + + lastserverstart + the last time this Management Server was started + date + + + lastserverstop + the last time this Management Server was stopped + date + + + name + the name of the management server + string + + + osdistribution + the name of the OS distribution running on the management server + string + + + serviceip + the IP Address for this Management Server + string + + + state + the state of the management server + state + + + version + the version of the management server + string + + + false + + + listTungstenFabricPolicyRule + list Tungsten-Fabric policy + false + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + ruleuuid + the uuid of Tungsten-Fabric rule + false + string + + + zoneid + the ID of zone + false + uuid + + + + + action + Tungsten-Fabric policy action + string + + + destendport + Tungsten-Fabric policy destination end port + int + + + destipprefix + Tungsten-Fabric policy destination ip prefix + string + + + destipprefixlen + Tungsten-Fabric policy destination ip prefix length + int + + + destnetwork + Tungsten-Fabric policy destination network + string + + + deststartport + Tungsten-Fabric policy destination start port + int + + + direction + Tungsten-Fabric policy name + string + + + policyuuid + Tungsten-Fabric policy uuid + string + + + protocol + Tungsten-Fabric policy protocol + string + + + srcendport + Tungsten-Fabric policy source end port + int + + + srcipprefix + Tungsten-Fabric policy source ip prefix + string + + + srcipprefixlen + Tungsten-Fabric policy source ip prefix length + int + + + srcnetwork + Tungsten-Fabric policy source network + string + + + srcstartport + Tungsten-Fabric policy source start port + int + + + uuid + Tungsten-Fabric rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + deleteTungstenFabricPolicy + delete Tungsten-Fabric policy + true + + + policyuuid + the Uuid of Tungsten-Fabric tag type + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateInstanceGroup + Updates a vm group + false + + + id + Instance group ID + true + uuid + + + name + new instance group name + false + string + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + domainpath + path of the Domain the instance group belongs to + 4.19.2.0 + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + listTemplateDirectDownloadCertificates + List the uploaded certificates for direct download templates + false + 4.17.0 + + + id + list direct download certificate by ID + false + uuid + + + keyword + List by keyword + false + string + + + listhosts + if set to true: include the hosts where the certificate is uploaded to + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the zone where certificates are uploaded + false + uuid + + + + + id + the direct download certificate id + string + + + alias + the direct download certificate alias + string + + + hostsmap + the hosts where the certificate is uploaded to + list + + + hypervisor + the hypervisor of the hosts where the certificate is uploaded + string + + + issuer + the direct download certificate issuer + string + + + serialnum + the direct download certificate serial num + string + + + subject + the direct download certificate subject + string + + + validity + the direct download certificate issuer + string + + + version + the direct download certificate version + string + + + zoneid + the zone id where the certificate is uploaded + string + + + zonename + the zone name where the certificate is uploaded + string + + + false + + + listUcsManagers + List ucs manager + false + + + id + the ID of the ucs manager + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the zone id + false + uuid + + + + + id + the ID of the ucs manager + string + + + name + the name of ucs manager + string + + + url + the url of ucs manager + string + + + zoneid + the zone ID of ucs manager + string + + + false + + + changeServiceForRouter + Upgrades domain router to a new service offering + false + + + id + The ID of the router + true + uuid + + + serviceofferingid + the service offering ID to apply to the domain router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateVolume + Updates the volume. + true + + + chaininfo + The chain info of the volume + false + 4.4 + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displayvolume + an optional field, whether to the display the volume to the end user or not. + false + boolean + + + id + the ID of the disk volume + false + uuid + + + name + new name of the volume + false + 4.16 + string + + + path + The path of the volume + false + string + + + state + The state of the volume + false + 4.3 + string + + + storageid + Destination storage pool UUID for the volume + false + 4.3 + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTrafficTypes + Lists traffic types of a given physical network. + false + 3.0.0 + + + physicalnetworkid + the Physical Network ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + updateVirtualMachine + Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call. + false + + + id + The ID of the virtual machine + true + uuid + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + details + Details in key/value pairs. 'extraconfig' is not allowed to be passed in details. + false + map + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + displayname + user generated name + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + group of the virtual machine + false + string + + + haenable + true if high-availability is enabled for the virtual machine, false otherwise + false + boolean + + + instancename + instance name of the user vm + false + 4.4 + string + + + isdynamicallyscalable + true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting + false + boolean + + + name + new host name of the vm. The VM has to be stopped/started for this update to take affect + false + 4.4 + string + + + ostypeid + the ID of the OS type that best represents this VM. + false + uuid + + + securitygroupids + list of security group ids to be applied on the virtual machine. + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + 4.16.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the userdata + false + 4.18 + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateAccount + Updates account information for the authenticated user + false + + + account + Current account name + false + string + + + accountdetails + Details for the account used to store specific parameters + false + map + map + + + domainid + The UUID of the domain where the account exists + false + uuid + + + id + Account UUID + false + uuid + + + networkdomain + Network domain for the account's networks; empty string will update domainName with NULL value + false + string + + + newname + New name for the account + false + string + + + roleid + The UUID of the dynamic role to set for the account + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + addSecondaryStorage + Adds secondary storage. + false + + + url + the URL for the secondary storage + true + string + + + zoneid + the Zone ID for the secondary storage + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + disableAccount + Disables an account + true + + + lock + If true, only lock the account; else disable the account + true + boolean + + + account + Disables specified account. + false + string + + + domainid + Disables specified account in this domain. + false + uuid + + + id + Account id + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + listDomains + Lists domains and provides detailed information for listed domains + false + + + details + comma separated list of domain details requested, value can be a list of [ all, resource, min] + false + list + list + + + id + List domain by domain ID. + false + uuid + + + keyword + List by keyword + false + string + + + level + List domains by domain level. + false + integer + + + listall + 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 + false + boolean + + + name + List domain by domain name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for domains + false + boolean + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + resetUserDataForVirtualMachine + Resets the UserData for virtual machine. The virtual machine must be in a "Stopped" state. [async] + false + + + id + The ID of the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the virtual machine + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + map + + + userdataid + the ID of the userdata + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listNetworkACLLists + Lists all network ACLs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists network ACL with the specified ID. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list network ACLs by specified name + false + string + + + networkid + list network ACLs by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + list network ACLs by VPC ID + false + uuid + + + + + id + the ID of the ACL + string + + + description + Description of the ACL + string + + + fordisplay + is ACL for display to the regular user + 4.4 + boolean + + + name + the Name of the ACL + string + + + vpcid + Id of the VPC this ACL is associated with + string + + + vpcname + Name of the VPC this ACL is associated with + string + + + false + + + deleteTemplate + Deletes a template from the system. All virtual machines using the deleted template will not be affected. + true + + + id + the ID of the template + true + uuid + + + forced + Force delete a template. + false + 4.9+ + boolean + + + zoneid + the ID of zone of the template + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + archiveSnapshot + Archives (moves) a snapshot on primary storage to secondary storage + true + + + id + The ID of the snapshot + true + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateVpnGateway + Updates site to site vpn local gateway + true + 4.4 + + + id + id of customer gateway + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + releaseDedicatedGuestVlanRange + Releases a dedicated guest vlan range to the system + true + + + id + the ID of the dedicated guest vlan range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSecurityGroup + Deletes security group + false + + + account + the account of the security group. Must be specified with domain ID + false + string + + + domainid + the domain ID of account owning the security group + false + uuid + + + id + The ID of the security group. Mutually exclusive with name parameter + false + uuid + + + name + The ID of the security group. Mutually exclusive with id parameter + false + string + + + projectid + the project of the security group + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + importVolume + Import an unmanaged volume from a storage pool on a host into CloudStack + true + 4.19.1 + + + path + the path of the volume + true + string + + + storageid + the ID of the storage pool + true + uuid + + + account + an optional account for the volume. Must be used with domainId. + false + string + + + diskofferingid + the ID of the disk offering linked to the volume + false + uuid + + + domainid + import volume to the domain specified + false + uuid + + + name + the name of the volume. If not set, it will be set to the path of the volume. + false + string + + + projectid + import volume for the project + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTemplate + Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it. + true + + + name + the name of the template + true + string + + + ostypeid + the ID of the OS Type that best represents the OS of this template. + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + 4.19.0 + string + + + bits + 32 or 64 bit + false + integer + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + The display text of the template, defaults to the 'name'. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + 4.19.0 + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if this template is a public template, false otherwise + false + boolean + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + create template for the project + false + uuid + + + requireshvm + true if the template requires HVM, false otherwise + false + boolean + + + snapshotid + the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in + false + uuid + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + url + Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server + false + string + + + virtualmachineid + Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal + false + uuid + + + volumeid + the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in + false + uuid + + + zoneid + the zone for the template. Can be specified with snapshot only + false + 4.19.0 + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + restoreBackup + Restores an existing stopped or deleted VM using a VM backup + true + 4.14.0 + + + id + ID of the backup + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listDedicatedClusters + Lists dedicated clusters. + false + + + account + the name of the account associated with the cluster. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated clusters by affinity group + false + uuid + + + clusterid + the ID of the cluster + false + uuid + + + domainid + the ID of the domain associated with the cluster + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the cluster + string + + + affinitygroupid + the Dedication Affinity Group ID of the cluster + string + + + clusterid + the ID of the cluster + string + + + clustername + the name of the cluster + string + + + domainid + the domain ID of the cluster + string + + + false + + + uploadCustomCertificate + Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself. + true + + + certificate + The certificate to be uploaded. + true + string + + + domainsuffix + DNS domain suffix that the certificate is granted for. + true + string + + + id + An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3 + false + integer + + + name + A name / alias for the certificate. + false + string + + + privatekey + The private key for the attached certificate. + false + string + + + + + message + message of the certificate upload operation + string + + + false + + + quotaUpdate + Update quota calculations, alerts and statements + false + 4.7.0 + + + + updated_on + timestamp when the run got over + date + + + false + + + listTungstenFabricNetwork + list Tungsten-Fabric network + false + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false + false + boolean + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric network name + string + + + uuid + Tungsten-Fabric network uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listTrafficMonitors + List traffic monitor Hosts. + false + + + zoneid + zone Id + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the external firewall + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + updatePortForwardingRule + Updates a port forwarding rule. Only the private port and the virtual machine can be updated. + true + + + id + the ID of the port forwarding rule + true + 4.4 + uuid + + + cidrlist + the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed. + false + list + list + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + privateendport + the private end port of the port forwarding rule + false + integer + + + privateport + the private start port of the port forwarding rule + false + integer + + + virtualmachineid + the ID of the virtual machine for the port forwarding rule + false + uuid + + + vmguestip + VM guest nic Secondary ip address for the port forwarding rule + false + 4.5 + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + associateIpAddress + Acquires and associates a public IP to an account. + true + + + account + the account to associate with this IP address + false + string + + + domainid + the ID of the domain to associate with this IP address + false + uuid + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + 4.4 + boolean + + + ipaddress + IP Address to be associated + false + string + + + isportable + should be set to true if public IP is required to be transferable across zones, if not specified defaults to false + false + boolean + + + networkid + The network this IP address should be associated to. + false + uuid + + + projectid + Deploy VM for the project + false + uuid + + + regionid + region ID from where portable IP is to be associated. + false + integer + + + vpcid + the VPC you want the IP address to be associated with + false + uuid + + + zoneid + the ID of the availability zone you want to acquire an public IP address from + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + getSolidFireVolumeAccessGroupIds + Get the SF Volume Access Group IDs + false + + + clusterid + Cluster UUID + true + string + + + storageid + Storage Pool UUID + true + string + + + + + solidFireVolumeAccessGroupIds + SolidFire Volume Access Group Ids + long[] + + + false + + + deleteVpnConnection + Delete site to site vpn connection + true + + + id + id of vpn connection + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAlertTypes + Lists all alerts types + false + + + + id + the id of the alert + string + + + description + description of the alert + string + + + name + the name of the alert + 4.3 + string + + + sent + the date and time the alert was sent + date + + + type + One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29 + short + + + false + + + resetSSHKeyForVirtualMachine + Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async] + true + + + id + The ID of the virtual machine + true + uuid + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs to be used to login to the virtual machine + false + list + 4.17 + list + + + projectid + an optional project for the ssh key + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteManagementNetworkIpRange + Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated. + true + 4.11.0.0 + + + endip + The ending IP address. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + startip + The starting IP address. + true + string + + + vlan + The vlan id the ip range sits on + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createNetworkACL + Creates a ACL rule in the given network (the network has to belong to VPC) + true + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + true + string + + + aclid + The network of the VM the ACL will be created for + false + uuid + + + action + scl entry action, allow or deny + false + string + + + cidrlist + the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of ACL + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + networkid + The network of the VM the ACL will be created for + false + uuid + + + number + The number of the ACL item, its ordering + false + integer + + + reason + A description indicating why the ACL rule is required. + false + string + + + startport + the starting port of ACL + false + integer + + + traffictype + the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + addKubernetesSupportedVersion + Add a supported Kubernetes version + false + + + mincpunumber + the minimum number of CPUs to be set with the Kubernetes version + true + integer + + + minmemory + the minimum RAM size in MB to be set with the Kubernetes version + true + integer + + + semanticversion + the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format + true + string + + + checksum + the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + directdownload + If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false + false + 4.18.2 + boolean + + + name + the name of the Kubernetes supported version + false + string + + + url + the URL of the binaries ISO for Kubernetes supported version + false + string + + + zoneid + the ID of the zone in which Kubernetes supported version will be available + false + uuid + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + directdownload + KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage + 4.18.2 + boolean + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + linkUserDataToTemplate + Link or unlink a userdata to a template. + false + 4.18.0 + + + isoid + the ID of the ISO for the virtual machine + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + userdataid + the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO + false + uuid + + + userdatapolicy + an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride + false + string + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listGlobalLoadBalancerRules + Lists load balancer rules. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the global load balancer rule + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + regionid + region ID + false + integer + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + deleteDiskOffering + Updates a disk offering. + false + + + id + ID of the disk offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + releaseDedicatedCluster + Release the dedication for cluster + true + + + clusterid + the ID of the Cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getKubernetesClusterConfig + Get Kubernetes cluster config + false + + + id + the ID of the Kubernetes cluster + false + uuid + + + + + id + the id of the container cluster + string + + + configdata + the config data of the cluster + string + + + name + Name of the container cluster + string + + + false + + + deleteAutoScalePolicy + Deletes a autoscale policy. + true + + + id + the ID of the autoscale policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteCiscoNexusVSM + delete a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteRole + Deletes a role + false + 4.9.0 + + + id + ID of the role + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listInternalLoadBalancerVMs + List internal LB VMs. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fetchhealthcheckresults + if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false + false + 4.14 + boolean + + + forvpc + if true is passed for this parameter, list only VPC Internal LB VMs + false + boolean + + + hostid + the host ID of the Internal LB VM + false + uuid + + + id + the ID of the Internal LB VM + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the Internal LB VM + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the Internal LB VM + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + the state of the Internal LB VM + false + string + + + vpcid + List Internal LB VMs by VPC + false + uuid + + + zoneid + the Zone ID of the Internal LB VM + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listCiscoVnmcResources + Lists Cisco VNMC controllers + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + resourceid + Cisco VNMC resource ID + false + uuid + + + + false + + + executeClusterDrsPlan + Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail. + true + 4.19.0 + + + id + ID of cluster + true + uuid + + + migrateto + Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=<uuid>&migrateto[vm-index].host=<uuid> Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm=<uuid> indicates the UUID of the vm that you want to migrate, and host=<uuid> indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc> + false + map + map + + + + + id + unique ID of the drs plan for cluster + string + + + clusterid + Id of the cluster + string + + + eventid + Start event Id of the DRS Plan + string + + + migrations + List of migrations + list + + + status + Status of DRS Plan + status + + + type + Type of DRS Plan (Automated or Manual)) + type + + + false + + + revokeSecurityGroupEgress + Deletes a particular egress rule from this security group + true + 3.0.0 + + + id + The ID of the egress rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + uploadResourceIcon + Uploads an icon for the specified resource(s) + false + 4.16.0.0 + + + base64image + Base64 string representation of the resource icon/image + true + string + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateKubernetesSupportedVersion + Update a supported Kubernetes version + false + + + id + the ID of the Kubernetes supported version + true + uuid + + + state + the enabled or disabled state of the Kubernetes supported version + true + string + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + directdownload + KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage + 4.18.2 + boolean + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + createGuestNetworkIpv6Prefix + Creates a guest network IPv6 prefix. + true + 4.17.0.0 + + + prefix + The /56 or higher IPv6 CIDR for network prefix. + true + string + + + zoneid + UUID of zone to which the IPv6 prefix belongs to. + true + uuid + + + + + id + id of the guest IPv6 prefix + string + + + availablesubnets + count of the available IPv6 subnets for the prefix. + integer + + + created + date when this IPv6 prefix was created. + date + + + prefix + guest IPv6 prefix + string + + + totalsubnets + count of the total IPv6 subnets for the prefix. + integer + + + usedsubnets + count of the used IPv6 subnets for the prefix. + integer + + + zoneid + id of zone to which the IPv6 prefix belongs to. + string + + + false + + + createRole + Creates a role + false + 4.9.0 + + + name + Creates a role with this unique name + true + string + + + description + The description of the role + false + string + + + ispublic + Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true. + false + boolean + + + roleid + ID of the role to be cloned from. Either roleid or type must be passed in + false + uuid + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + getUploadParamsForVolume + Upload a data disk to the cloudstack cloud. + false + 4.6.0 + + + format + the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume/template/iso + true + string + + + zoneid + the ID of the zone the volume/template/iso is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + checksum + the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + diskofferingid + the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown. + false + uuid + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + imagestoreuuid + Image store uuid + false + string + + + projectid + Upload volume/template/iso for the project + false + uuid + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + updateAutoScaleVmProfile + Updates an existing autoscale vm profile. + true + + + id + the ID of the autoscale vm profile + true + uuid + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + false + uuid + + + counterparam + counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161 + false + map + map + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + false + integer + + + fordisplay + an optional field, whether to the display the profile to the end user or not + false + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. +Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 . +Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". + false + map + 4.18.0 + map + + + serviceofferingid + the service offering of the auto deployed virtual machine + false + 4.18.0 + uuid + + + templateid + the template of the auto deployed virtual machine + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + 4.18.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18.1 + map + + + userdataid + the ID of the userdata + false + 4.18.1 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + domainpath + path of the domain to which the vm profile belongs + 4.19.2.0 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base64 encoded VM user data + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.1 + string + + + userdataid + the id of userdata used for the VM + 4.18.1 + string + + + userdataname + the name of userdata used for the VM + 4.18.1 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.1 + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + enableAutoScaleVmGroup + Enables an AutoScale Vm Group + true + + + id + the ID of the autoscale group + true + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + listGuestNetworkIpv6Prefixes + Lists guest network IPv6 prefixes + false + 4.17.0 + + + id + UUID of the IPv6 prefix. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + UUID of zone to which the IPv6 prefix belongs to. + false + uuid + + + + + id + id of the guest IPv6 prefix + string + + + availablesubnets + count of the available IPv6 subnets for the prefix. + integer + + + created + date when this IPv6 prefix was created. + date + + + prefix + guest IPv6 prefix + string + + + totalsubnets + count of the total IPv6 subnets for the prefix. + integer + + + usedsubnets + count of the used IPv6 subnets for the prefix. + integer + + + zoneid + id of zone to which the IPv6 prefix belongs to. + string + + + false + + + updateGuestOsMapping + Updates the information about Guest OS to Hypervisor specific name mapping + true + 4.4.0 + + + id + UUID of the Guest OS to hypervisor name Mapping + true + uuid + + + osnameforhypervisor + Hypervisor specific name for this Guest OS + true + string + + + osmappingcheckenabled + When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.) + false + 4.19.0 + boolean + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + deleteTungstenFabricTag + delete Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateHostPassword + Update password of a host/pool on management server. + false + + + password + the new password for the host/cluster + true + string + + + username + the username for the host/cluster + true + string + + + clusterid + the cluster ID + false + uuid + + + hostid + the host ID + false + uuid + + + update_passwd_on_host + if the password should also be updated on the hosts + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createPortableIpRange + adds a range of portable public IP's to a region + true + 4.2.0 + + + endip + the ending IP address in the portable IP range + true + string + + + gateway + the gateway for the portable IP range + true + string + + + netmask + the netmask of the portable IP range + true + string + + + regionid + Id of the Region + true + integer + + + startip + the beginning IP address in the portable IP range + true + string + + + vlan + VLAN id, if not specified defaulted to untagged + false + string + + + + + id + portable IP range ID + string + + + endip + the end ip of the portable IP range + string + + + gateway + the gateway of the VLAN IP range + string + + + netmask + the netmask of the VLAN IP range + string + + + regionid + Region Id in which portable ip range is provisioned + integer + + + startip + the start ip of the portable IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + portableipaddress(*) + List of portable IP and association with zone/network/vpc details that are part of GSLB rule + + + accountid + the account ID the portable IP address is associated with + string + + + allocated + date the portal IP address was acquired + date + + + domainid + the domain ID the portable IP address is associated with + string + + + ipaddress + public IP address + string + + + networkid + the ID of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + regionid + Region Id in which global load balancer is created + integer + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing and Free + string + + + vpcid + VPC the ip belongs to + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + list + + + false + + + updateCluster + Updates an existing cluster + false + + + id + the ID of the Cluster + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + clustername + the cluster name + false + string + + + clustertype + hypervisor type of the cluster + false + string + + + hypervisor + hypervisor type of the cluster + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + listVmwareDcVms + Lists the VMs in a VMware Datacenter + false + + + datacentername + Name of VMware datacenter. + false + string + + + existingvcenterid + UUID of a linked existing vCenter + false + uuid + + + hostname + Name of the host on vCenter. Must be set along with the instancename parameter + false + string + + + instancename + Name of the VM on vCenter. Must be set along with the hostname parameter + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + password + The password for specified username. + false + string + + + username + The Username required to connect to resource. + false + string + + + vcenter + The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + bootmode + indicates the boot mode + string + + + boottype + indicates the boot type + string + + + clusterid + the ID of the cluster to which virtual machine belongs + string + + + clustername + the name of the cluster to which virtual machine belongs + string + + + cpucorepersocket + the CPU cores per socket for the virtual machine. VMware specific + integer + + + cpunumber + the CPU cores of the virtual machine + integer + + + cpuspeed + the CPU speed of the virtual machine + integer + + + hostid + the ID of the host to which virtual machine belongs + string + + + hostname + the name of the host to which virtual machine belongs + string + + + memory + the memory of the virtual machine in MB + integer + + + name + the name of the virtual machine + string + + + osdisplayname + the operating system of the virtual machine + string + + + osid + the operating system ID of the virtual machine + string + + + powerstate + the power state of the virtual machine + string + + + disk(*) + the list of disks associated with the virtual machine + + + id + the ID of the disk + string + + + capacity + the capacity of the disk in bytes + long + + + controller + the controller of the disk + string + + + controllerunit + the controller unit of the disk + integer + + + datastorehost + the controller of the disk + string + + + datastorename + the controller of the disk + string + + + datastorepath + the controller of the disk + string + + + datastoretype + the controller of the disk + string + + + imagepath + the file path of the disk image + string + + + label + the label of the disk + string + + + position + the position of the disk + integer + + + set + + + nic(*) + the list of nics associated with the virtual machine + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listStorageProviders + Lists storage providers. + false + + + type + the type of storage provider: either primary or image + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + the name of the storage provider + string + + + type + the type of the storage provider: primary or image provider + string + + + false + + + listUcsProfiles + List profile in ucs manager + false + + + ucsmanagerid + the id for the ucs manager + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + ucsdn + ucs profile dn + string + + + false + + + getUserKeys + This command allows the user to query the seceret and API keys for the account + false + 4.10.0 + + + id + ID of the user whose keys are required + true + uuid + + + + + apikey + the api key of the registered user + string + + + secretkey + the secret key of the registered user + string + + + false + + + updateGlobalLoadBalancerRule + update global load balancer rules. + true + + + id + the ID of the global load balancer rule + true + uuid + + + description + the description of the load balancer rule + false + string + + + gslblbmethod + load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin' + false + string + + + gslbstickysessionmethodname + session sticky method (sourceip) if not specified defaults to sourceip + false + string + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + authorizeSamlSso + Allow or disallow a user to use SAML SSO + false + + + enable + If true, authorizes user to be able to use SAML for Single Sign. If False, disable user to user SAML SSO. + true + boolean + + + userid + User uuid + true + uuid + + + entityid + The Identity Provider ID the user is allowed to get single signed on from + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addGuestOs + Add a new guest OS type + true + 4.4.0 + + + oscategoryid + ID of Guest OS category + true + uuid + + + osdisplayname + Unique display name for Guest OS + true + string + + + details + Map of (key/value pairs) + false + map + map + + + forDisplay + whether this guest OS is available for end users + false + boolean + + + name + Optional name for Guest OS + false + string + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + fordisplay + is the guest OS visible for the users + boolean + + + isuserdefined + is the guest OS user defined + boolean + + + name + the name of the OS type + string + + + oscategoryid + the ID of the OS category + string + + + oscategoryname + the name of the OS category + string + + + false + + + listHostTags + Lists host tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the host tag + string + + + hostid + the host ID of the host tag + long + + + name + the name of the host tag + string + + + false + + + addAnnotation + add an annotation. + false + 4.11 + + + adminsonly + the annotation is visible for admins only + false + 4.16.0 + boolean + + + annotation + the annotation text + false + string + + + entityid + the id of the entity to annotate + false + string + + + entitytype + The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER + false + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + listIdps + Returns list of discovered SAML Identity Providers + false + + + + id + The IdP Entity ID + string + + + orgName + The IdP Organization Name + string + + + orgUrl + The IdP Organization URL + string + + + false + + + deployNetscalerVpx + Creates new NS Vpx + true + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + networkid + The network this ip address should be associated to. + false + uuid + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + listElastistorVolume + Lists the volumes of elastistor + false + + + id + the ID of the account + true + string + + + + + id + the id of the volume + string + + + compression + compression + string + + + deduplication + deduplication + string + + + graceallowed + graceallowed + string + + + name + the name of the volume + string + + + sync + synchronization + string + + + false + + + addBaremetalPxeKickStartServer + add a baremetal pxe server + true + + + password + Credentials to reach external pxe device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + pxeservertype + type of pxe device + true + string + + + tftpdir + Tftp root directory of PXE server + true + string + + + url + URL of the external pxe device + true + string + + + username + Credentials to reach external pxe device + true + string + + + podid + Pod Id + false + uuid + + + + + tftpdir + Tftp root directory of PXE server + string + + + false + + + listNiciraNvpDevices + Lists Nicira NVP devices + false + + + keyword + List by keyword + false + string + + + nvpdeviceid + nicira nvp device ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + hostname + the controller Ip address + string + + + l2gatewayserviceuuid + this L2 gateway service Uuid + string + + + l3gatewayserviceuuid + this L3 gateway service Uuid + string + + + niciradevicename + device name + string + + + nvpdeviceid + device id of the Nicire Nvp + string + + + physicalnetworkid + the physical network to which this Nirica Nvp belongs to + string + + + provider + name of the provider + string + + + transportzoneuuid + the transport zone Uuid + string + + + false + + + listAlerts + Lists all alerts. + false + + + id + the ID of the alert + false + uuid + + + keyword + List by keyword + false + string + + + name + list by alert name + false + 4.3 + string + + + page + false + integer + + + pagesize + false + integer + + + type + list by alert type + false + string + + + + + id + the id of the alert + string + + + description + description of the alert + string + + + name + the name of the alert + 4.3 + string + + + sent + the date and time the alert was sent + date + + + type + One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29 + short + + + false + + + deployVirtualMachine + Creates and automatically starts a virtual machine based on a service offering, disk offering, and template. + true + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter + false + list + list + + + bootintosetup + Boot into hardware setup or not (ignored if startVm = false, only valid for vmware) + false + 4.15.0.0 + boolean + + + bootmode + Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + boottype + Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + clusterid + destination Cluster ID to deploy the VM to - parameter available for root admin only + false + 4.13 + uuid + + + copyimagetags + if true the image tags (if any) will be copied to the VM, default value is false + false + 4.13 + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter + false + map + 4.11 + map + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + details + used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details + false + map + 4.3 + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + diskofferingid + the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created. + false + uuid + + + displayname + an optional user generated name for the virtual machine + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + 4.2 + boolean + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain. + false + uuid + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable + false + 4.16 + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + an optional group for the virtual machine + false + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + uuid + + + hypervisor + the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call + false + string + + + iodriverpolicy + Controls specific policies on IO + false + string + + + iothreadsenabled + IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs. + false + boolean + + + ip6address + the ipv6 address for default vm's network + false + string + + + ipaddress + the ip address for default vm's network + false + string + + + iptonetworklist + ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid + false + map + map + + + keyboard + an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us + false + string + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs used to login to the virtual machine + false + list + 4.17 + list + + + macaddress + the mac address for default vm's network + false + string + + + name + host name for the virtual machine + false + string + + + networkids + list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter + false + list + list + + + nicmultiqueuenumber + The number of queues for multiqueue NICs. + false + 4.18 + integer + + + nicnetworklist + VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid + false + map + 4.15 + map + + + nicpackedvirtqueuesenabled + Enable packed virtqueues or not. + false + 4.18 + boolean + + + overridediskofferingid + the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id + false + 4.17 + uuid + + + password + The password of the virtual machine. If null, a random password will be generated for the VM. + false + 4.19.0.0 + string + + + podid + destination Pod ID to deploy the VM to - parameter available for root admin only + false + 4.13 + uuid + + + projectid + Deploy vm for the project + false + uuid + + + properties + used to specify the vApp properties. + false + map + 4.15 + map + + + rootdisksize + Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.4 + long + + + securitygroupids + comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + size + the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId + false + long + + + startvm + true if start vm after creating; defaulted to true if not specified + false + boolean + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the Userdata + false + 4.18 + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVolumes + Lists all volumes. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster id the disk volume belongs to + false + uuid + + + diskofferingid + list volumes by disk offering + false + 4.4 + uuid + + + displayvolume + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hostid + list volumes on specified host + false + uuid + + + id + the ID of the disk volume + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id + false + list + 4.9 + list + + + isencrypted + list only volumes that are encrypted + false + 4.19.1 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + listsystemvms + list system VMs; only ROOT admin is eligible to pass this parameter + false + 4.18 + boolean + + + name + the name of the disk volume + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod id the disk volume belongs to + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + serviceofferingid + list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored + false + 4.19.1 + uuid + + + state + state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged. + false + string + + + storageid + the ID of the storage pool, available to ROOT admin only + false + 4.3 + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + type + the type of disk volume + false + string + + + virtualmachineid + the ID of the virtual machine + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createLBHealthCheckPolicy + Creates a load balancer health check policy + true + 4.2.0 + + + lbruleid + the ID of the load balancer rule + true + uuid + + + description + the description of the load balancer health check policy + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + healthythreshold + Number of consecutive health check success before declaring an instance healthy + false + integer + + + intervaltime + Amount of time between health checks (1 sec - 20940 sec) + false + integer + + + pingpath + HTTP ping path + false + string + + + responsetimeout + Time to wait when receiving a response from the health check (2sec - 60 sec) + false + integer + + + unhealthythreshold + Number of consecutive health check failures before declaring an instance unhealthy + false + integer + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + lockUser + Locks a user account + false + + + id + Locks user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + cloudianIsEnabled + Checks if the Cloudian Connector is enabled + false + 4.11.0 + + + + enabled + the Cloudian connector enabled state + boolean + + + url + the Cloudian Management Console base URL + string + + + false + + + createNetwork + Creates a network + false + + + name + the name of the network + true + string + + + networkofferingid + the network offering ID + true + uuid + + + zoneid + the zone ID for the network + true + uuid + + + account + Account that will own the network. Account should be under the selected domain + false + string + + + aclid + Network ACL ID associated for the network + false + uuid + + + acltype + Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network + false + string + + + associatednetworkid + The network this network is associated to. only available if create a Shared network + false + 4.17.0 + uuid + + + bypassvlanoverlapcheck + when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks + false + boolean + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + false + boolean + + + displaytext + the display text of the network + false + string + + + dns1 + the first IPv4 DNS for the network + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the network + false + 4.18.0 + string + + + domainid + domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain. + false + uuid + + + endip + the ending IP address in the network IP range. If not specified, will be defaulted to startIP + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + externalid + ID of the network in an external system. + false + string + + + gateway + the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC + false + string + + + hideipaddressusage + when true ip address usage for the network will not be exported by the listUsageRecords API + false + boolean + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6dns1 + the first IPv6 DNS for the network + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + false + 4.18.0 + string + + + ip6gateway + the gateway of the IPv6 network. Required for Shared networks + false + string + + + isolatedpvlan + the isolated private VLAN for this network + false + string + + + isolatedpvlantype + the isolated private VLAN type for this network + false + string + + + netmask + the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC + false + string + + + networkdomain + network domain + false + string + + + physicalnetworkid + the physical network ID the network belongs to + false + uuid + + + privatemtu + MTU to be configured on the network VR's private interface(s) + false + 4.18.0 + integer + + + projectid + an optional project for the network + false + uuid + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + routerip + IPV4 address to be assigned to a router in a shared network + false + 4.16 + string + + + routeripv6 + IPV6 address to be assigned to a router in a shared network + false + 4.16 + string + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. +If an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented, + false + 4.19 + string + + + startip + the beginning IP address in the network IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + subdomainaccess + Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified + false + boolean + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + false + string + + + vlan + the ID or VID of the network + false + string + + + vpcid + the VPC network belongs to + false + uuid + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listNetworkOfferings + Lists all available network offerings. + false + + + availability + the availability of network offering. Default value is required + false + string + + + displaytext + list network offerings by display text + false + string + + + domainid + list network offerings available for network creation in specific domain + false + 4.13 + uuid + + + forvpc + the network offering can be used only for network creation inside the VPC + false + boolean + + + guestiptype + list network offerings by guest type: shared or isolated + false + string + + + id + list network offerings by ID + false + uuid + + + isdefault + true if need to list only default network offerings. Default value is false + false + boolean + + + istagged + true if offering has tags specified + false + boolean + + + keyword + List by keyword + false + string + + + name + list network offerings by name + false + string + + + networkid + the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to. + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + sourcenatsupported + true if need to list only netwok offerings where source NAT is supported, false otherwise + false + boolean + + + specifyipranges + true if need to list only network offerings which support specifying ip ranges + false + boolean + + + specifyvlan + the tags for the network offering. + false + boolean + + + state + list network offerings by state + false + string + + + supportedservices + list network offerings supporting certain services + false + list + list + + + tags + list network offerings by tags + false + string + + + traffictype + list by traffic type + false + string + + + zoneid + list network offerings available for network creation in specific zone + false + uuid + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + listDedicatedPods + Lists dedicated pods. + false + + + account + the name of the account associated with the pod. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated pods by affinity group + false + uuid + + + domainid + the ID of the domain associated with the pod + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the ID of the pod + false + uuid + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Pod is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the pod + string + + + domainid + the domain ID to which the Pod is dedicated + string + + + podid + the ID of the Pod + string + + + podname + the Name of the Pod + string + + + false + + + listVPCs + Lists VPCs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + cidr + list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR + false + string + + + displaytext + List by display text of the VPC + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + list VPC by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list by name of the VPC + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + restartrequired + list VPCs by restartRequired option + false + boolean + + + showicon + flag to display the resource icon for VPCs + false + boolean + + + state + list VPCs by state + false + string + + + supportedservices + list VPC supporting certain services + false + list + list + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vpcofferingid + list by ID of the VPC offering + false + uuid + + + zoneid + list by zone + false + uuid + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + runDiagnostics + Execute network-utility command (ping/arping/tracert) on system VMs remotely + true + 4.12.0.0 + + + ipaddress + The IP/Domain address to test connection to + true + string + + + targetid + The ID of the system VM instance to diagnose + true + uuid + + + type + The system VM diagnostics type valid options are: ping, traceroute, arping + true + string + + + params + Additional command line options that apply for each command + false + string + + + + + exitcode + the command execution return code + string + + + stderr + the standard error output from the command execution + string + + + stdout + the standard output from the command execution + string + + + false + + + addNetworkDevice + Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer + false + + + networkdeviceparameterlist + parameters for network device + false + map + map + + + networkdevicetype + Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall + false + string + + + + + id + the ID of the network device + string + + + false + + + restartVPC + Restarts a VPC + true + + + id + the id of the VPC + true + uuid + + + cleanup + If cleanup old network elements + false + boolean + + + livepatch + Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false. + false + 4.17.0 + boolean + + + makeredundant + Turn a single VPC into a redundant one. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteTungstenFabricApplicationPolicySet + delete Tungsten-Fabric application policy set + true + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addBaremetalDhcp + adds a baremetal dhcp server + true + + + dhcpservertype + Type of dhcp device + true + string + + + password + Credentials to reach external dhcp device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the external dhcp appliance. + true + string + + + username + Credentials to reach external dhcp device + true + string + + + + + id + device id of + string + + + dhcpservertype + name of the provider + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + copySnapshot + Copies a snapshot from one zone to another. + true + 4.19.0 + + + id + the ID of the snapshot. + true + uuid + + + destzoneid + The ID of the zone the snapshot is being copied to. + false + uuid + + + destzoneids + A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required. + false + list + list + + + sourcezoneid + The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used. + false + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addTrafficMonitor + Adds Traffic Monitor Host for Direct Network Usage + false + + + url + URL of the traffic monitor Host + true + string + + + zoneid + Zone in which to add the external firewall appliance. + true + uuid + + + excludezones + Traffic going into the listed zones will not be metered + false + string + + + includezones + Traffic going into the listed zones will be metered + false + string + + + + + id + the ID of the external firewall + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + listUsers + Lists user accounts + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accounttype + List users by account type. Valid types include admin, domain-admin, read-only-admin, or user. + false + integer + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + List user by ID. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for users + false + boolean + + + state + List users by state of the user account. + false + string + + + username + List user by the username + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + updateVlanIpRange + Updates a VLAN IP range. + false + 4.16.0 + + + id + the UUID of the VLAN IP range + true + uuid + + + endip + the ending IP address in the VLAN IP range + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + forsystemvms + true if IP range is set to system vms, false if not + false + boolean + + + gateway + the gateway of the VLAN IP range + false + string + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6gateway + the gateway of the IPv6 network + false + string + + + netmask + the netmask of the VLAN IP range + false + string + + + startip + the beginning IP address in the VLAN IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + listResourceLimits + Lists resource limits. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + Lists resource limits by ID. + false + long + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourcetype + Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + integer + + + resourcetypename + Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + string + + + + + account + the account of the resource limit + string + + + domain + the domain name of the resource limit + string + + + domainid + the domain ID of the resource limit + string + + + domainpath + path of the domain to which the resource limit belongs + 4.19.2.0 + string + + + max + the maximum number of the resource. A -1 means the resource currently has no limit. + long + + + project + the project name of the resource limit + string + + + projectid + the project id of the resource limit + string + + + resourcetype + 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. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + false + + + disableUser + Disables a user account + true + + + id + Disables user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + listIsos + Lists all available ISO files. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + bootable + true if the ISO is bootable, false otherwise + false + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + list ISO by ID + false + uuid + + + imagestoreid + ID of the image or image cache store + false + 4.19 + uuid + + + isofilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + false + string + + + ispublic + true if the ISO is publicly available to all users, false otherwise. + false + boolean + + + isready + true if this ISO is ready to be deployed + false + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list all ISOs by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the isos + false + boolean + + + showremoved + show removed ISOs as well + false + boolean + + + showunique + If set to true, list only unique isos across zones + false + 4.13.2 + boolean + + + storageid + ID of the storage pool + false + 4.19 + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + zoneid + the ID of the zone + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listAutoScalePolicies + Lists autoscale policies. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + false + string + + + conditionid + the ID of the condition of the policy + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the autoscale policy + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vmgroupid + the ID of the autoscale vm group + false + uuid + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + domainpath + path of the domain to which the autoscale policy belongs + 4.19.2.0 + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + addBaremetalRct + adds baremetal rack configuration text + true + + + baremetalrcturl + http url to baremetal RCT configuration + true + object + + + + + id + id of rct + string + + + url + url + string + + + false + + + updateRole + Updates a role + false + 4.9.0 + + + id + ID of the role + true + uuid + + + description + The description of the role + false + string + + + description + The description of the role + false + string + + + ispublic + Indicates whether the role will be visible to all users (public) or only to root admins (private). + false + boolean + + + name + creates a role with this unique name + false + string + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + listRemoteAccessVpns + Lists remote access vpns + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists remote access vpn rule with the specified ID + false + 4.3 + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list remote access VPNs for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + publicipid + public ip address id of the vpn server + false + uuid + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + deleteNetworkACLList + Deletes a network ACL + true + + + id + the ID of the network ACL + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + removeIpFromNic + Removes secondary IP from the NIC. + true + + + id + the ID of the secondary ip address to nic + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createServiceInstance + Creates a system virtual-machine that implements network services + true + + + leftnetworkid + The left (inside) network for service instance + true + uuid + + + name + The name of the service instance + true + string + + + rightnetworkid + The right (outside) network ID for the service instance + true + uuid + + + serviceofferingid + The service offering ID that defines the resources consumed by the service appliance + true + uuid + + + templateid + The template ID that specifies the image for the service appliance + true + uuid + + + zoneid + Availability zone for the service instance + true + uuid + + + account + An optional account for the virtual machine. Must be used with domainId. + false + string + + + domainid + An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + Project ID for the service instance + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the Domain in which the virtual machine exists + 4.19.2.0 + string + + + name + the name of the virtual machine + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + false + + + startSystemVm + Starts a system virtual machine. + true + + + id + The ID of the system virtual machine + true + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + registerVnfTemplate + Registers an existing VNF template into the CloudStack cloud. + false + 4.19.0 + + + format + the format for the template. Possible values include QCOW2, RAW, VHD and OVA. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the template + true + string + + + url + the URL of where the template is hosted. Possible URL include http:// and https:// + true + string + + + account + an optional accountName. Must be used with domainId. + false + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + directdownload + true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + displaytext + The display text of the template, defaults to 'name'. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Register template for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + 4.19.0 + string + + + vnfdetails + VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0 + false + map + map + + + vnfnics + VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC + false + map + map + + + zoneid + the ID of the zone the template is to be hosted on + false + uuid + + + zoneids + A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. + false + list + list + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVirtualMachinesUsageHistory + Lists VM stats + false + 4.17 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the virtual machine. + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + name + the name of the virtual machine + string + + + stats + the list of VM stats + list + + + false + + + declareHostAsDegraded + Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host. + true + 4.16.0.0 + + + id + host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createKubernetesCluster + Creates a Kubernetes cluster + true + + + name + name for the Kubernetes cluster + true + string + + + zoneid + availability zone in which Kubernetes cluster to be launched + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged. + false + 4.19.0 + string + + + controlnodes + number of Kubernetes cluster control nodes, default is 1 + false + long + + + description + description for the Kubernetes cluster + false + string + + + dockerregistrypassword + password for the docker image private registry + false + string + + + dockerregistryurl + URL for the docker image private registry + false + string + + + dockerregistryusername + user name for the docker image private registry + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + externalloadbalanceripaddress + external load balancer IP address while using shared network with Kubernetes HA cluster + false + string + + + keypair + name of the ssh key pair used to login to the virtual machines + false + string + + + kubernetesversionid + Kubernetes version with which cluster to be launched + false + uuid + + + masternodes + number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter. + false + long + + + networkid + Network in which Kubernetes cluster is to be launched + false + uuid + + + noderootdisksize + root disk size in GB for each node + false + long + + + projectid + Deploy cluster for the project + false + uuid + + + serviceofferingid + the ID of the service offering for the virtual machines in the cluster. + false + uuid + + + size + number of Kubernetes cluster worker nodes + false + long + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + listStorageNetworkIpRange + List a storage network IP range. + false + 3.0.0 + + + id + optional parameter. Storaget network IP range uuid, if specicied, using it to search the range. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range. + false + uuid + + + zoneid + optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range. + false + uuid + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + enableHAForHost + Enables HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + configureVirtualRouterElement + Configures a virtual router element. + true + + + id + the ID of the virtual router provider + true + uuid + + + enabled + Enabled/Disabled the service provider + true + boolean + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + updateVMAffinityGroup + Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. + true + + + id + The ID of the virtual machine + true + uuid + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + registerNetscalerServicePackage + Registers NCC Service Package + false + + + description + Description of Service Package + true + string + + + name + Name of the service Package. + true + string + + + + + id + Service Package UUID + string + + + description + Description of Service Package + string + + + name + Service Package Name + string + + + false + + + quotaCredits + Add +-credits to an account + false + 4.7.0 + + + account + Account Id for which quota credits need to be added + true + string + + + domainid + Domain for which quota credits need to be added + true + uuid + + + value + Value of the credits to be added+, subtracted- + true + double + + + min_balance + Minimum balance threshold of the account + false + double + + + quota_enforce + Account for which quota enforce is set to false will not be locked when there is no credit balance + false + boolean + + + + + credits + the credit deposited + bigdecimal + + + currency + currency + string + + + updated_by + the user name of the admin who updated the credits + string + + + updated_on + the account name of the admin who updated the credits + date + + + false + + + listCaCertificate + Lists the CA public certificate(s) as support by the configured/provided CA plugin + false + 4.11.0 + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + cacertificates + The CA certificate(s) + string + + + certificate + The client certificate + string + + + privatekey + Private key for the certificate + string + + + false + + + provisionTemplateDirectDownloadCertificate + Provisions a host with a direct download certificate + false + 4.17.0 + + + id + the id of the direct download certificate to provision + true + uuid + + + hostid + the host to provision the certificate + true + uuid + + + + + details + indicates the details in case of failure or host skipped + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + status + indicates if the certificate has been revoked from the host, failed or skipped + string + + + false + + + samlSlo + SAML Global Log Out API + false + + + + description + Response description + string + + + false + + + updateProjectRole + Creates a Project role + false + 4.15.0 + + + id + ID of the Project role + true + uuid + + + projectid + ID of project where role is being created + true + uuid + + + description + The description of the Project role + false + string + + + name + creates a project role with this unique name + false + string + + + + + projectid + the id of the project + string + + + false + + + addLdapConfiguration + Add a new Ldap Configuration + false + 4.2.0 + + + hostname + Hostname + true + string + + + port + Port + true + integer + + + domainid + linked domain + false + uuid + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port the ldap server is running on + int + + + false + + + createTungstenFabricAddressGroup + create Tungsten-Fabric address group + true + + + ipprefix + Tungsten-Fabric ip prefix + true + string + + + ipprefixlen + Tungsten-Fabric ip prefix length + true + integer + + + name + Tungsten-Fabric address group name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + ipprefix + Tungsten-Fabric address group ip prefix + string + + + ipprefixlen + Tungsten-Fabric address group ip prefix length + int + + + name + Tungsten-Fabric address group name + string + + + uuid + Tungsten-Fabric address group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listBigSwitchBcfDevices + Lists BigSwitch BCF Controller devices + false + 4.6.0 + + + bcfdeviceid + bigswitch BCF controller device ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + bcfdeviceid + device id of the BigSwitch BCF Controller + string + + + bigswitchdevicename + device name + string + + + hostname + the controller Ip address + string + + + nat + NAT support + boolean + + + password + the controller password + string + + + physicalnetworkid + the physical network to which this BigSwitch BCF segment belongs to + string + + + provider + name of the provider + string + + + username + the controller username + string + + + false + + + listRegisteredServicePackages + lists registered service packages + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + Service Package UUID + string + + + description + Description of Service Package + string + + + name + Service Package Name + string + + + false + + + enableStaticNat + Enables static NAT for given IP address + false + + + ipaddressid + the public IP address ID for which static NAT feature is being enabled + true + uuid + + + virtualmachineid + the ID of the virtual machine for enabling static NAT feature + true + uuid + + + networkid + The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case) + false + uuid + + + vmguestip + VM guest NIC secondary IP address for the port forwarding rule + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteZone + Deletes a Zone. + false + + + id + the ID of the Zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getUploadParamsForTemplate + upload an existing template into the CloudStack cloud. + false + 4.6.0 + + + format + the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the volume/template/iso + true + string + + + zoneid + the ID of the zone the volume/template/iso is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs. + false + map + map + + + displaytext + the display text of the template. This is usually used for display purposes. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file. + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Upload volume/template/iso for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + deleteSnapshotPolicies + Deletes snapshot policies for the account. + false + + + id + the Id of the snapshot policy + false + uuid + + + ids + list of snapshots policy IDs separated by comma + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTrafficTypeImplementors + Lists implementors of implementor of a network traffic type or implementors of all network traffic types + false + 3.0.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + traffictype + Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor + false + string + + + + + traffictype + network traffic type + string + + + traffictypeimplementor + implementor of network traffic type + string + + + false + + + listDbMetrics + list the db hosts and statistics + false + 4.17.0 + + + + collectiontime + the time these statistics were collected + date + + + connections + the number of connections to the DB + int + + + dbloadaverages + the last measured load averages on the DB + double[] + + + hostname + the name of the active usage server + string + + + queries + the number of queries performed on the DB + long + + + replicas + the state of the usage server + string[] + + + tlsversions + the tls versions currently in use (accepted) by the DB + string + + + uptime + the uptime of the DB in seconds + long + + + version + the version of the currently running DB + string + + + versioncomment + the version of the currently running DB + string + + + false + + + deleteImageStore + Deletes an image store or Secondary Storage. + false + 4.2.0 + + + id + The image store ID or Secondary Storage ID. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAutoScaleVmProfiles + Lists autoscale vm profiles. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the autoscale vm profile + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + otherdeployparams + the otherdeployparameters of the autoscale vm profile + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + serviceofferingid + list profiles by service offering id + false + 4.4 + uuid + + + templateid + the templateid of the autoscale vm profile + false + uuid + + + zoneid + availability zone for the auto deployed virtual machine + false + 4.4 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + domainpath + path of the domain to which the vm profile belongs + 4.19.2.0 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base64 encoded VM user data + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.1 + string + + + userdataid + the id of userdata used for the VM + 4.18.1 + string + + + userdataname + the name of userdata used for the VM + 4.18.1 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.1 + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + authorizeSecurityGroupIngress + Authorizes a particular ingress rule for this security group + true + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + cidrlist + the cidr list associated. Multiple entries must be separated by a single comma character (,). + false + list + list + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + endport + end port for this ingress rule + false + integer + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + projectid + an optional project of the security group + false + uuid + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default. + false + string + + + securitygroupid + The ID of the security group. Mutually exclusive with securityGroupName parameter + false + uuid + + + securitygroupname + The name of the security group. Mutually exclusive with securityGroupId parameter + false + string + + + startport + start port for this ingress rule + false + integer + + + usersecuritygrouplist + user to security group mapping + false + map + map + + + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + syncStoragePool + Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it) + true + 4.15.1 + + + id + Storage pool id + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateBucket + Updates Bucket properties + false + 4.19.0 + + + id + The ID of the Bucket + true + uuid + + + encryption + Enable/Disable Bucket encryption + false + boolean + + + policy + Bucket Access Policy + false + string + + + quota + Bucket Quota in GB + false + integer + + + versioning + Enable/Disable Bucket Versioning + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateResourceCount + Recalculate and update resource count for an account or domain. + false + + + domainid + If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain. + true + uuid + + + account + Update resource count for a specified account. Must be used with the domainId parameter. + false + string + + + projectid + Update resource limits for project + false + uuid + + + resourcetype + Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + integer + + + + + account + the account for which resource count's are updated + string + + + domain + the domain name for which resource count's are updated + string + + + domainid + the domain ID for which resource count's are updated + string + + + domainpath + path of the domain to which the resource counts are updated + 4.19.2.0 + string + + + project + the project name for which resource count's are updated + string + + + projectid + the project id for which resource count's are updated + string + + + resourcecount + resource count + long + + + resourcetype + resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + false + + + listRoles + Lists dynamic roles in CloudStack + false + 4.9.0 + + + id + List role by role ID. + false + uuid + + + keyword + List by keyword + false + string + + + name + List role by role name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + type + List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User. + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + listTungstenFabricPolicy + list Tungsten-Fabric policy + false + + + ipaddressid + the ID of ip address + false + uuid + + + keyword + List by keyword + false + string + + + networkid + the ID of network + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + downloadImageStoreObject + Download object at a specified path on an image store. + true + 4.19.0 + + + id + id of the image store + true + uuid + + + path + path to download on image store + false + string + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + getCloudIdentifier + Retrieves a cloud identifier. + false + + + userid + the user ID for the cloud identifier + true + uuid + + + + + cloudidentifier + the cloud identifier + string + + + signature + the signed response for the cloud identifier + string + + + userid + the user ID for the cloud identifier + string + + + false + + + createLBStickinessPolicy + Creates a load balancer stickiness policy + true + 3.0.0 + + + lbruleid + the ID of the load balancer rule + true + uuid + + + methodname + name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased + true + string + + + name + name of the load balancer stickiness policy + true + string + + + description + the description of the load balancer stickiness policy + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + param + param list. Example: param[0].name=cookiename&param[0].value=LBCookie + false + map + map + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + configurePaloAltoFirewall + Configures a Palo Alto firewall device + true + + + fwdeviceid + Palo Alto firewall device ID + true + uuid + + + fwdevicecapacity + capacity of the firewall device, Capacity will be interpreted as number of networks device can handle + false + long + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + addCiscoAsa1000vResource + Adds a Cisco Asa 1000v appliance + false + + + clusterid + the Cluster ID + true + uuid + + + hostname + Hostname or ip address of the Cisco ASA 1000v appliance. + true + string + + + insideportprofile + Nexus port profile associated with inside interface of ASA 1000v + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + + false + + + updateNetworkACLItem + Updates ACL item with specified ID + true + + + id + the ID of the network ACL item + true + uuid + + + action + scl entry action, allow or deny + false + string + + + cidrlist + the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + endport + the ending port of ACL + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + number + The network of the vm the ACL will be created for + false + integer + + + partialupgrade + Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'. + false + boolean + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + false + string + + + reason + A description indicating why the ACL rule is required. + false + string + + + startport + the starting port of ACL + false + integer + + + traffictype + the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listRouters + List routers. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster ID of the router + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fetchhealthcheckresults + if true is passed for this parameter, also fetch last executed health check results for the router. Default is false + false + 4.14 + boolean + + + forvpc + if true is passed for this parameter, list only VPC routers + false + boolean + + + healthchecksfailed + if this parameter is passed, list only routers by health check results + false + 4.16 + boolean + + + hostid + the host ID of the router + false + uuid + + + id + the ID of the disk router + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the router + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the router + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + the state of the router + false + string + + + version + list virtual router elements by version + false + string + + + vpcid + List networks by VPC + false + uuid + + + zoneid + the Zone ID of the router + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listTungstenFabricVm + list Tungsten-Fabric vm + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + vmuuid + the uuid of Tungsten-Fabric vm + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric vm name + string + + + uuid + Tungsten-Fabric nic uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + deletePhysicalNetwork + Deletes a Physical Network. + true + 3.0.0 + + + id + the ID of the Physical network + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addTungstenFabricPolicyRule + add Tungsten-Fabric policy rule + true + + + action + Tungsten-Fabric policy rule action + true + string + + + destendport + Tungsten-Fabric policy rule destination end port + true + integer + + + destipprefix + Tungsten-Fabric policy rule destination ip prefix + true + string + + + destipprefixlen + Tungsten-Fabric policy rule destination ip prefix length + true + integer + + + destnetwork + Tungsten-Fabric policy rule destination network + true + string + + + deststartport + Tungsten-Fabric policy rule destination start port + true + integer + + + direction + Tungsten-Fabric policy rule direction + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + protocol + Tungsten-Fabric policy rule protocol + true + string + + + srcendport + Tungsten-Fabric policy rule source end port + true + integer + + + srcipprefix + Tungsten-Fabric policy rule source ip prefix + true + string + + + srcipprefixlen + Tungsten-Fabric policy rule source ip prefix length + true + integer + + + srcnetwork + Tungsten-Fabric policy rule source network + true + string + + + srcstartport + Tungsten-Fabric policy rule source start port + true + integer + + + zoneid + the ID of zone + true + uuid + + + + + action + Tungsten-Fabric policy action + string + + + destendport + Tungsten-Fabric policy destination end port + int + + + destipprefix + Tungsten-Fabric policy destination ip prefix + string + + + destipprefixlen + Tungsten-Fabric policy destination ip prefix length + int + + + destnetwork + Tungsten-Fabric policy destination network + string + + + deststartport + Tungsten-Fabric policy destination start port + int + + + direction + Tungsten-Fabric policy name + string + + + policyuuid + Tungsten-Fabric policy uuid + string + + + protocol + Tungsten-Fabric policy protocol + string + + + srcendport + Tungsten-Fabric policy source end port + int + + + srcipprefix + Tungsten-Fabric policy source ip prefix + string + + + srcipprefixlen + Tungsten-Fabric policy source ip prefix length + int + + + srcnetwork + Tungsten-Fabric policy source network + string + + + srcstartport + Tungsten-Fabric policy source start port + int + + + uuid + Tungsten-Fabric rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + removeVpnUser + Removes vpn user + true + + + username + username for the vpn user + true + string + + + account + an optional account for the vpn user. Must be used with domainId. + false + string + + + domainid + an optional domainId for the vpn user. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + remove vpn user from the project + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listQuarantinedIps + List public IP addresses in quarantine. + false + 4.19 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + showinactive + Show IPs that are no longer in quarantine. + false + boolean + + + showremoved + Show IPs removed from quarantine. + false + boolean + + + + + id + ID of the quarantine process. + string + + + created + When the quarantine was created. + date + + + enddate + End date for the quarantine. + date + + + ipaddress + The public IP address in quarantine. + string + + + previousownerid + Account ID of the previous public IP address owner. + string + + + previousownername + Account name of the previous public IP address owner. + string + + + removalreason + The reason for removing the IP from quarantine prematurely. + string + + + removed + When the quarantine was removed. + date + + + removeraccountid + ID of the account that removed the IP from quarantine. + string + + + false + + + deleteLBHealthCheckPolicy + Deletes a load balancer health check policy. + true + 4.2.0 + + + id + the ID of the load balancer health check policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableHAForHost + Disables HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + listSwifts + List Swift. + false + 3.0.0 + + + id + the id of the swift + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + enableOutOfBandManagementForHost + Enables out-of-band management for a host + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listKubernetesSupportedVersions + Lists supported Kubernetes version + false + + + id + the ID of the Kubernetes supported version + false + uuid + + + keyword + List by keyword + false + string + + + minimumkubernetesversionid + the ID of the minimum Kubernetes supported version + false + uuid + + + minimumsemanticversion + the minimum semantic version for the Kubernetes supported version to be listed + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of the zone in which Kubernetes supported version will be available + false + uuid + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + directdownload + KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage + 4.18.2 + boolean + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + deleteServiceOffering + Deletes a service offering. + false + + + id + the ID of the service offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addNiciraNvpDevice + Adds a Nicira NVP device + true + + + hostname + Hostname of ip address of the Nicira NVP Controller. + true + string + + + password + Credentials to access the Nicira Controller API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + transportzoneuuid + The Transportzone UUID configured on the Nicira Controller + true + string + + + username + Credentials to access the Nicira Controller API + true + string + + + l2gatewayserviceuuid + The L2 Gateway Service UUID configured on the Nicira Controller + false + string + + + l3gatewayserviceuuid + The L3 Gateway Service UUID configured on the Nicira Controller + false + string + + + + + hostname + the controller Ip address + string + + + l2gatewayserviceuuid + this L2 gateway service Uuid + string + + + l3gatewayserviceuuid + this L3 gateway service Uuid + string + + + niciradevicename + device name + string + + + nvpdeviceid + device id of the Nicire Nvp + string + + + physicalnetworkid + the physical network to which this Nirica Nvp belongs to + string + + + provider + name of the provider + string + + + transportzoneuuid + the transport zone Uuid + string + + + false + + + listInfrastructure + Lists infrastructure + false + 4.9.3 + + + + alerts + Number of Alerts + integer + + + clusters + Number of clusters + integer + + + cpusockets + Number of cpu sockets + integer + + + hosts + Number of hypervisor hosts + integer + + + ilbvms + Number of internal LBs + integer + + + imagestores + Number of images stores + integer + + + managementservers + Number of management servers + integer + + + objectstores + Number of object stores + integer + + + pods + Number of pods + integer + + + routers + Number of routers + integer + + + storagepools + Number of storage pools + integer + + + systemvms + Number of systemvms + integer + + + zones + Number of zones + integer + + + false + + + listUsageRecords + Lists usage records for accounts + false + + + enddate + End date range for usage record query (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00). + true + date + + + startdate + Start date range for usage record query (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00). + true + date + + + account + List usage records for the specified user. + false + string + + + accountid + List usage records for the specified account + false + uuid + + + domainid + List usage records for the specified domain. + false + uuid + + + includetags + Flag to enable display of Tags for a resource + false + boolean + + + isrecursive + Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account. + false + 4.15 + boolean + + + keyword + List by keyword + false + string + + + oldformat + Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + List usage records for specified project + false + uuid + + + type + List usage records for the specified usage type + false + long + + + usageid + List usage records for the specified usage UUID. Can be used only together with TYPE parameter. + false + string + + + + + account + the user account name + string + + + accountid + the user account Id + string + + + cpunumber + number of cpu of resource + long + + + cpuspeed + speed of each cpu of resource + long + + + description + description of the usage record + string + + + domain + the domain the resource is associated with + string + + + domainid + the domain ID + string + + + domainpath + path of the domain to which the usage reocrd belongs + 4.19.2.0 + string + + + enddate + end date of the usage record + string + + + isdefault + True if the resource is default + boolean + + + issourcenat + True if the IPAddress is source NAT + boolean + + + issystem + True if the IPAddress is system IP - allocated during vm deploy or lb rule create + boolean + + + memory + memory allocated for the resource + long + + + name + resource or virtual machine name + string + + + networkid + id of the network + string + + + offeringid + offering ID + string + + + oscategoryid + virtual machine guest os category ID + string + + + oscategoryname + virtual machine os category name + string + + + osdisplayname + virtual machine os display name + string + + + ostypeid + virtual machine os type ID + string + + + project + the project name of the resource + string + + + projectid + the project id of the resource + string + + + rawusage + raw usage in hours + string + + + size + resource size + long + + + startdate + start date of the usage record + string + + + templateid + template ID + string + + + type + resource type + string + + + usage + usage in hours + string + + + usageid + id of the resource + string + + + usagetype + usage type ID + integer + + + virtualmachineid + virtual machine ID + string + + + virtualsize + virtual size of resource + long + + + vpcid + id of the vpc + string + + + zoneid + the zone ID + string + + + false + + + recoverVolume + Recovers a Destroy volume. + false + 4.14.0 + + + id + The ID of the volume + true + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeTungstenFabricNetworkGatewayFromLogicalRouter + remove Tungsten-Fabric network gateway from logical router + true + + + logicalrouteruuid + Tungsten-Fabric logical router uuid + true + string + + + networkuuid + Tungsten-Fabric network uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listVolumesForImport + Lists unmanaged volumes on a storage pool + false + 4.19.1 + + + storageid + the ID of the storage pool + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the path of the volume on the storage pool + false + string + + + + + chaininfo + the chain info of the volume + string + + + details + volume details in key/value pairs. + map + + + encryptformat + the encrypt format of the volume + string + + + format + the format of the volume + string + + + fullpath + the full path of the volume + string + + + name + the name of the volume + string + + + path + the path of the volume + string + + + size + the size of the volume + long + + + storage + name of the primary storage hosting the volume + string + + + storageid + id of the primary storage hosting the volume + string + + + storagetype + type of the primary storage hosting the volume + string + + + virtualsize + the virtual size of the volume + long + + + false + + + listZonesMetrics + Lists zone metrics + false + 4.9.3 + + + available + true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false. + false + boolean + + + domainid + the ID of the domain associated with the zone + false + uuid + + + id + the ID of the zone + false + uuid + + + ids + the IDs of the zones, mutually exclusive with id + false + list + 4.19.0 + list + + + keyword + List by keyword + false + string + + + name + the name of the zone + false + string + + + networktype + the network type of the zone that the virtual machine belongs to + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the zones + false + boolean + + + showicon + flag to display the resource image for the zones + false + boolean + + + tags + List zones by resource tags (key/value pairs) + false + map + 4.3 + map + + + + + clusters + healthy / total clusters in the zone + string + + + cpuallocated + the total cpu allocated in Ghz + string + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpumaxdeviation + the maximum cpu deviation + string + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotal + the total cpu capacity in Ghz + string + + + cpuused + the total cpu used in Ghz + string + + + memoryallocated + the total cpu allocated in GiB + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorymaxdeviation + the maximum memory deviation + string + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotal + the total cpu capacity in GiB + string + + + memoryused + the total cpu used in GiB + string + + + state + state of the cluster + string + + + false + + + extractTemplate + Extracts a template + true + + + id + the ID of the template + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + url + the url to which the ISO would be extracted + false + string + + + zoneid + the ID of the zone where the ISO is originally located + false + uuid + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + expungeVirtualMachine + Expunge a virtual machine. Once expunged, it cannot be recoverd. + true + + + id + The ID of the virtual machine + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateIpAddress + Updates an IP address + true + + + id + the ID of the public IP address to update + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + 4.4 + boolean + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + migrateNetwork + moves a network to another physical network + true + 4.11.0 + + + networkid + the ID of the network + true + uuid + + + networkofferingid + network offering ID + true + uuid + + + resume + true if previous network migration cmd failed + false + boolean + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network supports specifying vlan, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listUnmanagedInstances + Lists unmanaged virtual machines for a given cluster. + false + 4.14.0 + + + clusterid + the cluster ID + true + uuid + + + keyword + List by keyword + false + string + + + name + the hypervisor name of the instance + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + bootmode + indicates the boot mode + string + + + boottype + indicates the boot type + string + + + clusterid + the ID of the cluster to which virtual machine belongs + string + + + clustername + the name of the cluster to which virtual machine belongs + string + + + cpucorepersocket + the CPU cores per socket for the virtual machine. VMware specific + integer + + + cpunumber + the CPU cores of the virtual machine + integer + + + cpuspeed + the CPU speed of the virtual machine + integer + + + hostid + the ID of the host to which virtual machine belongs + string + + + hostname + the name of the host to which virtual machine belongs + string + + + memory + the memory of the virtual machine in MB + integer + + + name + the name of the virtual machine + string + + + osdisplayname + the operating system of the virtual machine + string + + + osid + the operating system ID of the virtual machine + string + + + powerstate + the power state of the virtual machine + string + + + disk(*) + the list of disks associated with the virtual machine + + + id + the ID of the disk + string + + + capacity + the capacity of the disk in bytes + long + + + controller + the controller of the disk + string + + + controllerunit + the controller unit of the disk + integer + + + datastorehost + the controller of the disk + string + + + datastorename + the controller of the disk + string + + + datastorepath + the controller of the disk + string + + + datastoretype + the controller of the disk + string + + + imagepath + the file path of the disk image + string + + + label + the label of the disk + string + + + position + the position of the disk + integer + + + set + + + nic(*) + the list of nics associated with the virtual machine + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + registerTemplate + Registers an existing template into the CloudStack cloud. + false + + + format + the format for the template. Possible values include QCOW2, RAW, VHD and OVA. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the template + true + string + + + url + the URL of where the template is hosted. Possible URL include http:// and https:// + true + string + + + account + an optional accountName. Must be used with domainId. + false + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + directdownload + true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + displaytext + The display text of the template, defaults to 'name'. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Register template for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + 4.19.0 + string + + + zoneid + the ID of the zone the template is to be hosted on + false + uuid + + + zoneids + A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. + false + list + list + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVnfAppliances + List VNF appliance owned by the account. + false + 4.19.1 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + details + comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. + false + 4.19.0 + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userdataid + the instances by userdata + false + 4.20.1 + uuid + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addStratosphereSsp + Adds stratosphere ssp server + false + + + name + stratosphere ssp api name + true + string + + + url + stratosphere ssp server url + true + string + + + zoneid + the zone ID + true + uuid + + + password + stratosphere ssp api password + false + string + + + tenantuuid + stratosphere ssp tenant uuid + false + string + + + username + stratosphere ssp api username + false + string + + + + + hostid + server id of the stratosphere ssp server + string + + + name + name + string + + + url + url of ssp endpoint + string + + + zoneid + zone which this ssp controls + string + + + false + + + createStoragePool + Creates a storage pool. + false + + + name + the name for the storage pool + true + string + + + url + the URL of the storage pool + true + string + + + zoneid + the Zone ID for the storage pool + true + uuid + + + capacitybytes + bytes CloudStack can provision from this storage pool + false + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + false + long + + + clusterid + the cluster ID for the storage pool + false + uuid + + + details + the details for the storage pool + false + map + map + + + hypervisor + hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now. + false + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + false + boolean + + + managed + whether the storage should be managed by CloudStack + false + boolean + + + podid + the Pod ID for the storage pool + false + uuid + + + provider + the storage provider name + false + string + + + scope + the scope of the storage: cluster or zone + false + string + + + tags + the tags for the storage pool + false + string + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + findStoragePoolsForMigration + Lists storage pools available for migration of a volume. + false + + + id + the ID of the volume + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteTungstenFabricFirewallRule + delete Tungsten-Fabric firewall rule + true + + + firewallruleuuid + the uuid of Tungsten-Fabric firewall rule + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableCiscoNexusVSM + disable a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be deleted + true + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + createStorageNetworkIpRange + Creates a Storage network IP range. + true + 3.0.0 + + + gateway + the gateway for storage network + true + string + + + netmask + the netmask for storage network + true + string + + + podid + UUID of pod where the ip range belongs to + true + uuid + + + startip + the beginning IP address + true + string + + + endip + the ending IP address + false + string + + + vlan + Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table + false + integer + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + configureOvsElement + Configures an ovs element. + true + + + id + the ID of the ovs provider + true + uuid + + + enabled + Enabled/Disabled the service provider + true + boolean + + + + + id + the id of the ovs + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + listSystemVmsUsageHistory + Lists System VM stats + false + 4.18.0 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the system VM. + false + uuid + + + ids + the IDs of the system VMs, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + name + the name of the virtual machine + string + + + stats + the list of VM stats + list + + + false + + + deleteIpv6FirewallRule + Deletes a IPv6 firewall rule + true + + + id + the ID of the IPv6 firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createFirewallRule + Creates a firewall rule for a given IP address + true + + + ipaddressid + the IP address id of the port forwarding rule + true + uuid + + + protocol + the protocol for the firewall rule. Valid values are TCP/UDP/ICMP. + true + string + + + cidrlist + the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + startport + the starting port of firewall rule + false + integer + + + type + type of firewallrule: system/user + false + string + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createVolume + Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it. + true + + + account + the account associated with the disk volume. Must be used with the domainId parameter. + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + diskofferingid + the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in. + false + uuid + + + displayvolume + an optional field, whether to display the volume to the end user or not. + false + boolean + + + domainid + the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain. + false + uuid + + + maxiops + max iops + false + long + + + miniops + min iops + false + long + + + name + the name of the disk volume + false + string + + + projectid + the project associated with the volume. Mutually exclusive with account parameter + false + uuid + + + size + Arbitrary volume size + false + long + + + snapshotid + the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in. + false + uuid + + + virtualmachineid + the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVMSnapshot + List virtual machine snapshot by conditions + false + 4.2.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + lists snapshot by snapshot name or display name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + state of the virtual machine snapshot + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + the ID of the vm + false + uuid + + + vmsnapshotid + The ID of the VM snapshot + false + uuid + + + vmsnapshotids + the IDs of the vm snapshots, mutually exclusive with vmsnapshotid + false + list + 4.9 + list + + + + + id + the ID of the vm snapshot + string + + + account + the account associated with the disk volume + string + + + created + the create date of the vm snapshot + date + + + current + indicates if this is current snapshot + boolean + + + description + the description of the vm snapshot + string + + + displayname + the display name of the vm snapshot + string + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the domain to which the disk volume belongs + 4.19.2.0 + string + + + hypervisor + the type of hypervisor on which snapshot is stored + string + + + name + the name of the vm snapshot + string + + + parent + the parent ID of the vm snapshot + string + + + parentName + the parent displayName of the vm snapshot + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the vm snapshot + state + + + type + VM Snapshot type + string + + + virtualmachineid + the vm ID of the vm snapshot + string + + + virtualmachinename + the vm name of the vm snapshot + 4.15.1 + string + + + zoneid + the Zone ID of the vm snapshot + string + + + zonename + the Zone name of the vm snapshot + 4.15.1 + string + + + false + + + moveNetworkAclItem + Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list + true + + + id + The ID of the network ACL rule that is being moved to a new position. + true + string + + + aclconsistencyhash + Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field). + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + nextaclruleid + The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list. + false + string + + + previousaclruleid + The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list. + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listBaremetalDhcp + list baremetal dhcp servers + false + + + physicalnetworkid + the Physical Network ID + true + uuid + + + dhcpservertype + Type of DHCP device + false + string + + + id + DHCP server device ID + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + device id of + string + + + dhcpservertype + name of the provider + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + disassociateIpAddress + Disassociates an IP address from the account. + true + + + id + the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter + false + uuid + + + ipaddress + IP Address to be disassociated. Mutually exclusive with the id parameter + false + 4.19.0 + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + enableStorageMaintenance + Puts storage pool into maintenance state + true + + + id + Primary storage ID + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeSecondaryStorageSelector + Removes an existing secondary storage selector. + false + 4.19.0 + + + id + The unique identifier of the secondary storage selector to be removed. + true + uuid + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + listApis + lists all available apis on the server, provided by the Api Discovery plugin + false + 4.1.0 + + + name + API name + false + string + + + + + description + description of the api + string + + + isasync + true if api is asynchronous + boolean + + + name + the name of the api command + string + + + related + comma separated related apis + string + + + since + version of CloudStack the api was introduced in + string + + + type + response field type + string + + + params(*) + the list params the api accepts + + + description + description of the api parameter + string + + + length + length of the parameter + int + + + name + the name of the api parameter + string + + + related + comma separated related apis to get the parameter + string + + + required + true if this parameter is required for the api request + boolean + + + since + version of CloudStack the api was introduced in + string + + + type + parameter type + string + + + set + + + response(*) + api response fields + + + description + description of the api response field + string + + + name + the name of the api response field + string + + + response + api response fields + set + + + type + response field type + string + + + set + + + false + + + deleteBaremetalRct + deletes baremetal rack configuration text + true + + + id + RCT id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVMSnapshot + Creates snapshot for a vm. + true + 4.2.0 + + + virtualmachineid + The ID of the vm + true + uuid + + + description + The description of the snapshot + false + string + + + name + The display name of the snapshot + false + string + + + quiescevm + quiesce vm if true + false + boolean + + + snapshotmemory + snapshot memory if true + false + boolean + + + + + id + the ID of the vm snapshot + string + + + account + the account associated with the disk volume + string + + + created + the create date of the vm snapshot + date + + + current + indicates if this is current snapshot + boolean + + + description + the description of the vm snapshot + string + + + displayname + the display name of the vm snapshot + string + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the domain to which the disk volume belongs + 4.19.2.0 + string + + + hypervisor + the type of hypervisor on which snapshot is stored + string + + + name + the name of the vm snapshot + string + + + parent + the parent ID of the vm snapshot + string + + + parentName + the parent displayName of the vm snapshot + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the vm snapshot + state + + + type + VM Snapshot type + string + + + virtualmachineid + the vm ID of the vm snapshot + string + + + virtualmachinename + the vm name of the vm snapshot + 4.15.1 + string + + + zoneid + the Zone ID of the vm snapshot + string + + + zonename + the Zone name of the vm snapshot + 4.15.1 + string + + + false + + + deleteLoadBalancer + Deletes an internal load balancer + true + 4.2.0 + + + id + the ID of the Load Balancer + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricTagType + Lists Tungsten-Fabric tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + tagtypeuuid + the uuid of Tungsten-Fabric tag type + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric tag type name + string + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listSSHKeyPairs + List registered keypairs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fingerprint + A public key fingerprint to look for + false + string + + + id + the ID of the ssh keypair + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + A key pair name to look for + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the keypair + string + + + domain + the domain name of the keypair owner + string + + + domainid + the domain id of the keypair owner + string + + + fingerprint + Fingerprint of the public key + string + + + name + Name of the keypair + string + + + project + the project name of the keypair owner + string + + + projectid + the project id of the keypair owner + string + + + false + + + cancelStorageMaintenance + Cancels maintenance for primary storage + true + + + id + the primary storage ID + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + quotaSummary + Lists balance and quota usage for all accounts + false + 4.7.0 + + + account + Optional, Account Id for which statement needs to be generated + false + string + + + domainid + Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain. + false + uuid + + + keyword + List by keyword + false + string + + + listall + Optional, to list all accounts irrespective of the quota activity + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + + + account + account name + string + + + accountid + account id + string + + + balance + account balance + bigdecimal + + + currency + currency + string + + + domain + domain name + string + + + domainid + domain id + string + + + enddate + end date + date + + + quota + quota usage of this period + bigdecimal + + + quotaenabled + if the account has the quota config enabled + boolean + + + startdate + start date + date + + + state + account state + state + + + false + + + updateSnapshotPolicy + Updates the snapshot policy. + true + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the snapshot policy to the end user or not. + false + 4.4 + boolean + + + id + the ID of the snapshot policy + false + uuid + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + zone + The list of zones in which snapshot backup is scheduled + 4.19.0 + set + + + false + + + queryAsyncJobResult + Retrieves the current status of asynchronous job. + false + + + jobid + the ID of the asynchronous job + true + uuid + + + + + account + the account that executed the async command + string + + + accountid + the account id that executed the async command + string + + + cmd + the async command executed + string + + + completed + the completed date of the job + date + + + created + the created date of the job + date + + + domainid + the domain id that executed the async command + string + + + domainpath + the domain that executed the async command + string + + + jobinstanceid + the unique ID of the instance/entity object related to the job + string + + + jobinstancetype + the instance/entity object related to the job + string + + + jobprocstatus + the progress information of the PENDING job + integer + + + jobresult + the result reason + responseobject + + + jobresultcode + the result code for the job + integer + + + jobresulttype + the result type + string + + + jobstatus + the current job status-should be 0 for PENDING + integer + + + managementserverid + the msid of the management server on which the job is running + 4.19 + long + + + userid + the user that executed the async command + string + + + jobid + the ID of the async job + + + false + + + registerNetscalerControlCenter + Adds a netscaler control center device + true + + + ipaddress + URL of the netscaler controlcenter appliance. + true + string + + + numretries + Credentials to reach netscaler controlcenter device + true + integer + + + password + Credentials to reach netscaler controlcenter device + true + string + + + username + Credentials to reach netscaler controlcenter device + true + string + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + createCounter + Adds metric counter for VM auto scaling + true + + + name + Name of the counter. + true + string + + + provider + Network provider of the counter. + true + 4.18.0 + string + + + source + Source of the counter. + true + string + + + value + Value of the counter e.g. oid in case of snmp. + true + string + + + + + id + the id of the Counter + string + + + name + Name of the counter. + string + + + provider + Provider of the counter. + string + + + source + Source of the counter. + string + + + value + Value in case of snmp or other specific counters. + string + + + zoneid + zone id of counter + string + + + false + + + listEventTypes + List Event Types + false + + + + name + Event Type + string + + + false + + + prepareForShutdown + Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted + false + 4.19.0 + + + managementserverid + the uuid of the management server + true + uuid + + + + + managementserverid + The id of the management server + string + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + removeNicFromVirtualMachine + Removes VM from specified network by deleting a NIC + true + + + nicid + NIC ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addCluster + Adds a new cluster + false + + + clustername + the cluster name + true + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged + true + string + + + hypervisor + hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3 + true + string + + + podid + the Pod ID for the host + true + uuid + + + zoneid + the Zone ID for the cluster + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + guestvswitchname + Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting. + false + string + + + guestvswitchtype + Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch) + false + string + + + ovm3cluster + Ovm3 native OCFS2 clustering enabled for cluster + false + string + + + ovm3pool + Ovm3 native pooling enabled for cluster + false + string + + + ovm3vip + Ovm3 vip to use for pool (and cluster) + false + string + + + password + the password for the host + false + string + + + publicvswitchname + Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting. + false + string + + + publicvswitchtype + Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch) + false + string + + + url + the URL + false + string + + + username + the username for the cluster + false + string + + + vsmipaddress + the ipaddress of the VSM associated with this cluster + false + string + + + vsmpassword + the password for the VSM associated with this cluster + false + string + + + vsmusername + the username for the VSM associated with this cluster + false + string + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + deleteTrafficMonitor + Deletes an traffic monitor host. + false + + + id + Id of the Traffic Monitor Host. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listDedicatedHosts + Lists dedicated hosts. + false + + + account + the name of the account associated with the host. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated hosts by affinity group + false + uuid + + + domainid + the ID of the domain associated with the host + false + uuid + + + hostid + the ID of the host + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the host + string + + + affinitygroupid + the Dedication Affinity Group ID of the host + string + + + domainid + the domain ID of the host + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + false + + + getUploadParamsForIso + upload an existing ISO into the CloudStack cloud. + false + 4.13 + + + format + the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume/template/iso + true + string + + + zoneid + the ID of the zone the volume/template/iso is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + bootable + true if this ISO is bootable. If not passed explicitly its assumed to be true + false + boolean + + + checksum + the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + displaytext + the display text of the ISO. This is usually used for display purposes. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isextractable + true if the ISO or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if you want this ISO to be featured + false + boolean + + + ispublic + true if you want to register the ISO to be publicly available to all users, false otherwise. + false + boolean + + + ostypeid + the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed + false + uuid + + + projectid + Upload volume/template/iso for the project + false + uuid + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + getDiagnosticsData + Get diagnostics and files from system VMs + true + 4.14.0.0 + + + targetid + The ID of the system VM instance to retrieve diagnostics data files from + true + uuid + + + files + A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided. + false + list + list + + + + + url + Storage URL to download retrieve diagnostics data files + string + + + false + + + listPaloAltoFirewalls + lists Palo Alto firewall devices in a physical network + false + + + fwdeviceid + Palo Alto firewall device ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + deleteAutoScaleVmGroup + Deletes a autoscale vm group. + true + + + id + the ID of the autoscale group + true + uuid + + + cleanup + true if all VMs have to be cleaned up, false otherwise + false + 4.18.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateLoadBalancerRule + Updates load balancer + true + + + id + the ID of the load balancer rule to update + true + uuid + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + description + the description of the load balancer rule + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + name + the name of the load balancer rule + false + string + + + protocol + The protocol for the LB + false + string + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + enableAccount + Enables an account + false + + + account + Enables specified account. + false + string + + + domainid + Enables specified account in this domain. + false + uuid + + + id + Account id + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + changeStoragePoolScope + Changes the scope of a storage pool when the pool is in Disabled state.This feature is officially tested and supported for Hypervisors: KVM and VMware, Protocols: NFS and Ceph, and Storage Provider: DefaultPrimary. There might be extra steps involved to make this work for other hypervisors and storage options. + true + 4.19.1 + + + id + the Id of the storage pool + true + uuid + + + scope + the scope of the storage: cluster or zone + true + string + + + clusterid + the Id of the cluster to use if scope is being set to Cluster + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetwork + Deletes a network + true + + + id + the ID of the network + true + uuid + + + forced + Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + reconnectHost + Reconnects a host. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + startKubernetesCluster + Starts a stopped CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + deleteProject + Deletes a project + true + 3.0.0 + + + id + id of the project to be deleted + true + uuid + + + cleanup + true if all project resources have to be cleaned up, false otherwise + false + 4.16.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listIsoPermissions + List iso visibility and all accounts that have permissions to view this iso. + false + + + id + the template ID + true + uuid + + + + + id + the template ID + string + + + account + the list of accounts the template is available for + list + + + domainid + the ID of the domain to which the template belongs + string + + + ispublic + true if this template is a public template, false otherwise + boolean + + + projectids + the list of projects the template is available for + list + + + false + + + addNetscalerLoadBalancer + Adds a netscaler load balancer device + true + + + networkdevicetype + Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer + true + string + + + password + Credentials to reach netscaler load balancer device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the netscaler load balancer appliance. + true + string + + + username + Credentials to reach netscaler load balancer device + true + string + + + gslbprovider + true if NetScaler device being added is for providing GSLB service + false + boolean + + + gslbproviderprivateip + private IP of the site + false + string + + + gslbproviderpublicip + public IP of the site + false + string + + + isexclusivegslbprovider + true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB + false + boolean + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + listBackupSchedule + List backup schedule of a VM + false + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + intervaltype + the interval type of the backup schedule + intervaltype + + + schedule + time the backup is scheduled to be taken. + string + + + timezone + the time zone of the backup schedule + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + false + + + restoreVolumeFromBackupAndAttachToVM + Restore and attach a backed up volume to VM + true + 4.14.0 + + + backupid + ID of the VM backup + true + uuid + + + virtualmachineid + id of the VM where to attach the restored volume + true + uuid + + + volumeid + ID of the volume backed up + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + configTungstenFabricService + config Tungsten-Fabric service + false + + + physicalnetworkid + the ID of physical network + true + uuid + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + removeNetworkPermissions + Removes network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + accountids + a comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + accounts + a comma delimited list of accounts within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + projectids + a comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBaremetalPxeServers + list baremetal pxe server + false + + + physicalnetworkid + the Physical Network ID + true + uuid + + + id + Pxe server device ID + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + device id of + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + getUser + Find user account by API key + false + + + userapikey + API key of the user + true + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + listLoadBalancerRules + Lists load balancer rules. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer rule + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the load balancer rule + false + string + + + networkid + list by network ID the rule belongs to + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + publicipid + the public IP address ID of the load balancer rule + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + the ID of the virtual machine of the load balancer rule + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listCiscoNexusVSMs + Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster + false + + + clusterid + Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance. + false + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + createManagementNetworkIpRange + Creates a Management network IP range. + true + 4.11.0.0 + + + gateway + The gateway for the management network. + true + string + + + netmask + The netmask for the management network. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + startip + The starting IP address. + true + string + + + endip + The ending IP address. + false + string + + + forsystemvms + Specify if range is dedicated for CPVM and SSVM. + false + boolean + + + vlan + Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + addVpnUser + Adds vpn users + true + + + password + password for the username + true + string + + + username + username for the vpn user + true + string + + + account + an optional account for the vpn user. Must be used with domainId. + false + string + + + domainid + an optional domainId for the vpn user. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + add vpn user to the specific project + false + uuid + + + + + id + the vpn userID + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'. + string + + + username + the username of the vpn user + string + + + false + + + deleteBackup + Delete VM backup + true + 4.14.0 + + + id + id of the VM backup + true + uuid + + + forced + force the deletion of backup which removes the entire backup chain but keep VM in Backup Offering + false + 4.18.0.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteProjectRolePermission + Deletes a project role permission in the project + false + 4.15.0 + + + id + ID of the project role permission to be deleted + true + uuid + + + projectid + ID of the project where the project role permission is to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateQuarantinedIp + Updates the quarantine end date for the given public IP address. + false + 4.19 + + + enddate + The date when the quarantine will no longer be active. + true + date + + + id + The ID of the public IP address in active quarantine. + false + uuid + + + ipaddress + The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine. + false + string + + + + + id + ID of the quarantine process. + string + + + created + When the quarantine was created. + date + + + enddate + End date for the quarantine. + date + + + ipaddress + The public IP address in quarantine. + string + + + previousownerid + Account ID of the previous public IP address owner. + string + + + previousownername + Account name of the previous public IP address owner. + string + + + removalreason + The reason for removing the IP from quarantine prematurely. + string + + + removed + When the quarantine was removed. + date + + + removeraccountid + ID of the account that removed the IP from quarantine. + string + + + false + + + updateVnfTemplate + Updates a template to VNF template or attributes of a VNF template. + false + 4.19.0 + + + id + the ID of the image file + true + uuid + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + cleanupvnfdetails + optional boolean field, which indicates if VNF details will be cleaned up or not + false + boolean + + + cleanupvnfnics + optional boolean field, which indicates if VNF nics will be cleaned up or not + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + string + + + vnfdetails + VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0 + false + map + map + + + vnfnics + VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC + false + map + map + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateVPCOffering + Updates VPC offering + true + + + id + the id of the VPC offering + true + uuid + + + displaytext + the display text of the VPC offering + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + name + the name of the VPC offering + false + string + + + sortkey + sort key of the VPC offering, integer + false + integer + + + state + update state for the VPC offering; supported states - Enabled/Disabled + false + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + listSamlAuthorization + Lists authorized users who can used SAML SSO + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + userid + User uuid + false + uuid + + + + + idpid + the authorized Identity Provider ID + string + + + status + the SAML authorization status + boolean + + + userid + the user ID + string + + + false + + + listUserTwoFactorAuthenticatorProviders + Lists user two factor authenticator providers + false + 4.18.0 + + + name + List user two factor authenticator provider by name + false + string + + + + + description + the description of the user two factor authenticator provider + string + + + name + the user two factor authenticator provider name + string + + + false + + + scaleVirtualMachine + Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume. + true + + + id + The ID of the virtual machine + true + uuid + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + automigrate + Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering + false + 4.17 + boolean + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + maxiops + New maximum number of IOPS for the custom disk offering + false + 4.17 + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + 4.17 + long + + + shrinkok + Verify OK to Shrink + false + 4.17 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateEgressFirewallRule + Updates egress firewall rule + true + 4.4 + + + id + the ID of the egress firewall rule + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listServiceOfferings + Lists all available service offerings. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + cpunumber + the CPU number that listed offerings must support + false + 4.15 + integer + + + cpuspeed + the CPU speed that listed offerings must support + false + 4.15 + integer + + + domainid + list only resources belonging to the domain specified + false + uuid + + + encryptroot + listed offerings support root disk encryption + false + 4.18 + boolean + + + id + ID of the service offering + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issystem + is this a system vm offering + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + memory + the RAM memory that listed offering must support + false + 4.15 + integer + + + name + name of the service offering + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings. + false + 4.19 + string + + + storagetype + the storage type of the service offering. Values are local and shared. + false + 4.19 + string + + + systemvmtype + the system VM type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter". + false + string + + + virtualmachineid + the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to. + false + uuid + + + zoneid + id of zone disk offering is associated with + false + 4.13 + uuid + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + state + state of the service offering + string + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + listOsCategories + Lists all supported OS categories for this cloud. + false + + + id + list Os category by id + false + uuid + + + keyword + List by keyword + false + string + + + name + list os category by name + false + 3.0.1 + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the OS category + string + + + name + the name of the OS category + string + + + false + + + importVm + Import virtual machine from a unmanaged host into CloudStack + true + 4.19.0 + + + clusterid + the cluster ID + true + uuid + + + hypervisor + hypervisor type of the host + true + string + + + importsource + Source location for Import + true + string + + + name + the name of the instance as it is known to the hypervisor + true + string + + + serviceofferingid + the service offering for the virtual machine + true + uuid + + + zoneid + the zone ID + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + clustername + (only for importing VMs from VMware to KVM) Name of VMware cluster. + false + string + + + convertinstancehostid + (only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM. + false + uuid + + + convertinstancepoolid + (only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM. + false + uuid + + + datacentername + (only for importing VMs from VMware to KVM) Name of VMware datacenter. + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping using keys disk and diskOffering + false + map + map + + + details + used to specify the custom parameters. + false + map + map + + + diskpath + path of the disk image + false + string + + + displayname + the display name of the instance + false + string + + + domainid + import instance to the domain specified + false + uuid + + + existingvcenterid + (only for importing VMs from VMware to KVM) UUID of a linked existing vCenter + false + uuid + + + forced + VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated + false + boolean + + + forcemstoimportvmfiles + (only for importing VMs from VMware to KVM) optional - if true, forces MS to export OVF from VMware to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not. + false + boolean + + + host + the host name or IP address + false + string + + + hostid + Host where local disk is located + false + uuid + + + hostip + (only for importing VMs from VMware to KVM) VMware ESXi host IP/Name. + false + string + + + hostname + the host name of the instance + false + string + + + importinstancehostid + (only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM. + false + 4.19.2 + uuid + + + migrateallowed + vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool + false + boolean + + + networkid + the network ID + false + uuid + + + nicipaddresslist + VM nic to ip address mapping using keys nic, ip4Address + false + map + map + + + nicnetworklist + VM nic to network id mapping using keys nic and network + false + map + map + + + password + the password for the host + false + string + + + projectid + import instance for the project + false + uuid + + + storageid + Shared storage pool where disk is located + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + temppath + Temp Path on external host for disk image copy + false + string + + + username + the username for the host + false + string + + + vcenter + (only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeFromGlobalLoadBalancerRule + Removes a load balancer rule association with global load balancer rule + true + + + id + The ID of the load balancer rule + true + uuid + + + loadbalancerrulelist + the list load balancer rules that will be assigned to global load balancer rule + true + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAffinityGroupTypes + Lists affinity group types available + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + type + the type of the affinity group + string + + + false + + + listCapacity + Lists all the system wide capacities. + false + + + clusterid + lists capacity by the Cluster ID + false + 3.0.0 + uuid + + + fetchlatest + recalculate capacities and fetch the latest + false + 3.0.0 + boolean + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists capacity by the Pod ID + false + uuid + + + sortby + Sort the results. Available values: Usage + false + 3.0.0 + string + + + type + lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90. + false + integer + + + zoneid + lists capacity by the Zone ID + false + uuid + + + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + false + + + updateServiceOffering + Updates a service offering. + false + + + id + the ID of the service offering to be updated + true + uuid + + + displaytext + the display text of the service offering to be updated + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + hosttags + the host tag for this service offering. + false + 4.16 + string + + + name + the name of the service offering to be updated + false + string + + + sortkey + sort key of the service offering, integer + false + integer + + + state + state of the service offering + false + string + + + storagetags + comma-separated list of tags for the service offering, tags should match with existing storage pool tags + false + 4.16 + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + state + state of the service offering + string + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + stopVirtualMachine + Stops a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createNetworkACLList + Creates a network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone. + true + + + name + Name of the network ACL list + true + string + + + description + Description of the network ACL list + false + string + + + fordisplay + an optional field, whether to the display the list to the end user or not + false + 4.4 + boolean + + + vpcid + ID of the VPC associated with this network ACL list + false + uuid + + + + + id + the ID of the ACL + string + + + description + Description of the ACL + string + + + fordisplay + is ACL for display to the regular user + 4.4 + boolean + + + name + the Name of the ACL + string + + + vpcid + Id of the VPC this ACL is associated with + string + + + vpcname + Name of the VPC this ACL is associated with + string + + + false + + \ No newline at end of file diff --git a/4.19_commands.xml b/4.19_commands.xml new file mode 100644 index 0000000..2ce74cf --- /dev/null +++ b/4.19_commands.xml @@ -0,0 +1,130842 @@ + + + createVPCOffering + Creates VPC offering + true + + + name + the name of the vpc offering + true + string + + + supportedservices + services supported by the vpc offering + true + list + list + + + displaytext + the display text of the vpc offering, defaults to the 'name' + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + enable + set to true if the offering is to be enabled during creation. Default is false + false + 4.16 + boolean + + + internetprotocol + The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6 + false + 4.17.0 + string + + + servicecapabilitylist + desired service capabilities as part of vpc offering + false + map + 4.4 + map + + + serviceofferingid + the ID of the service offering for the VPC router appliance + false + uuid + + + serviceproviderlist + provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network + false + map + map + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + ldapCreateAccount + Creates an account from an LDAP user + false + 4.2.0 + + + username + Unique username. + true + string + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accountid + Account UUID, required for adding account from external provisioning system + false + string + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + Creates the user under the specified domain. + false + uuid + + + networkdomain + Network domain for the account's networks + false + string + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + copyIso + Copies an iso from one zone to another. + true + + + id + Template ID. + true + uuid + + + destzoneid + ID of the zone the template is being copied to. + false + uuid + + + destzoneids + 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. + false + list + list + + + sourcezoneid + 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. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteAutoScaleVmProfile + Deletes a autoscale vm profile. + true + + + id + the ID of the autoscale profile + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVsphereStoragePolicyCompatiblePools + List storage pools compatible with a vSphere storage policy + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + policyid + ID of the storage policy + false + uuid + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + rebootSystemVm + Reboots a system VM. + true + + + id + The ID of the system virtual machine + true + uuid + + + forced + Force reboot the system VM (System VM is Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + listDedicatedZones + List dedicated zones. + false + + + account + the name of the account associated with the zone. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated zones by affinity group + false + uuid + + + domainid + the ID of the domain associated with the zone + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of the Zone + false + uuid + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Zone is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the zone + string + + + domainid + the domain ID to which the Zone is dedicated + string + + + zoneid + the ID of the Zone + string + + + zonename + the Name of the Zone + string + + + false + + + listElastistorPool + Lists the pools of elastistor + false + + + id + the ID of the Pool + false + long + + + + + id + the ID of the storage pool + string + + + controllerid + controller of the pool + string + + + gateway + default gateway of the pool + string + + + maxiops + available iops of the pool + long + + + name + the name of the storage pool + string + + + size + the current available space of the pool + long + + + state + the state of the storage pool + string + + + false + + + listTungstenFabricLBHealthMonitor + list Tungsten-Fabric LB health monitor + false + + + lbruleid + the ID of lb rule + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the health monitor ID + long + + + expectedcode + the health monitor expected code + string + + + httpmethod + the health monitor http method + string + + + interval + the health monitor interval + int + + + lbruleid + the LB rule ID + string + + + retry + the health monitor retry + int + + + timeout + the health monitor timeout + int + + + type + the health monitor type + string + + + urlpath + the health monitor url path + string + + + uuid + the health monitor UUID + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + deleteAccountFromProject + Deletes account from the project + true + 3.0.0 + + + account + name of the account to be removed from the project + true + string + + + projectid + ID of the project to remove the account from + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listGuestVlans + Lists all guest vlans + false + 4.17.0 + + + allocatedonly + limits search results to allocated guest vlan. false by default. + false + boolean + + + id + list guest vlan by id + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + list guest vlan by physical network + false + uuid + + + vnet + list guest vlan by vnet + false + string + + + zoneid + list guest vlan by zone + false + uuid + + + + + id + the guest VLAN id + long + + + account + the account of the guest VLAN range + string + + + allocationstate + the allocation state of the guest VLAN + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + domainpath + path of the domain to which the guest VLAN range belongs + 4.19.2.0 + string + + + isdedicated + true if the guest VLAN is dedicated to the account + boolean + + + network + the list of networks who use this guest VLAN + list + + + physicalnetworkid + the physical network ID of the guest VLAN range + string + + + physicalnetworkname + the physical network name of the guest VLAN range + string + + + project + the project name of the guest VLAN range + string + + + projectid + the project id of the guest VLAN range + string + + + taken + date the guest VLAN was taken + date + + + vlan + the guest VLAN + string + + + zoneid + the zone ID of the guest VLAN range + string + + + zonename + the zone name of the guest VLAN range + string + + + false + + + updateGuestOs + Updates the information about Guest OS + true + 4.4.0 + + + id + UUID of the Guest OS + true + uuid + + + osdisplayname + Unique display name for Guest OS + true + string + + + details + Map of (key/value pairs) + false + map + map + + + forDisplay + whether this guest OS is available for end users + false + boolean + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + fordisplay + is the guest OS visible for the users + boolean + + + isuserdefined + is the guest OS user defined + boolean + + + name + the name of the OS type + string + + + oscategoryid + the ID of the OS category + string + + + oscategoryname + the name of the OS category + string + + + false + + + updateResourceLimit + Updates resource limits for an account or domain. + false + + + resourcetype + Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + true + integer + + + account + Update resource for a specified account. Must be used with the domainId parameter. + false + string + + + domainid + 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. + false + uuid + + + max + Maximum resource limit. + false + long + + + projectid + Update resource limits for project + false + uuid + + + + + account + the account of the resource limit + string + + + domain + the domain name of the resource limit + string + + + domainid + the domain ID of the resource limit + string + + + domainpath + path of the domain to which the resource limit belongs + 4.19.2.0 + string + + + max + the maximum number of the resource. A -1 means the resource currently has no limit. + long + + + project + the project name of the resource limit + string + + + projectid + the project id of the resource limit + string + + + resourcetype + 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. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + false + + + deleteStaticRoute + Deletes a static route + true + + + id + the ID of the static route + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getLoadBalancerSslCertificate + get load balancer certificate + false + + + id + the ID of Lb + true + uuid + + + + + chain + chain + string + + + crt + crt + string + + + key + key + string + + + false + + + deleteRemoteAccessVpn + Destroys a l2tp/ipsec remote access vpn + true + + + publicipid + public ip address id of the vpn server + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + startRollingMaintenance + Start rolling maintenance + true + + + clusterids + the IDs of the clusters to start maintenance on + false + list + list + + + forced + if rolling mechanism should continue in case of an error + false + boolean + + + hostids + the IDs of the hosts to start maintenance on + false + list + list + + + payload + the command to execute while hosts are on maintenance + false + string + + + podids + the IDs of the pods to start maintenance on + false + list + list + + + timeout + optional operation timeout (in seconds) that overrides the global timeout setting + false + integer + + + zoneids + the IDs of the zones to start maintenance on + false + list + list + + + + + details + in case of failure, details are displayed + string + + + success + indicates if the rolling maintenance operation was successful + boolean + + + hostsskipped(*) + the hosts skipped + + + hostid + the ID of the skipped host + string + + + hostname + the name of the skipped host + string + + + reason + the reason to skip the host + string + + + list + + + hostsupdated(*) + the hosts updated + + + enddate + end date of the update on the host + string + + + hostid + the ID of the updated host + string + + + hostname + the name of the updated host + string + + + output + output of the maintenance script on the host + string + + + startdate + start date of the update on the host + string + + + list + + + false + + + listTungstenFabricApplicationPolicySet + list Tungsten-Fabric application policy set + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + firewallpolicy + list Tungsten-Fabric firewall policy + list + + + name + Tungsten-Fabric policy name + string + + + tag + list Tungsten-Fabric tag + list + + + uuid + Tungsten-Fabric application policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateNetworkACLList + Updates network ACL list + true + 4.4 + + + id + the ID of the network ACL + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + description + Description of the network ACL list + false + string + + + fordisplay + an optional field, whether to the display the list to the end user or not + false + 4.4 + boolean + + + name + Name of the network ACL list + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + restoreVirtualMachine + Restore a VM to original template/ISO or new template/ISO + true + 3.0.0 + + + virtualmachineid + Virtual Machine ID + true + uuid + + + details + used to specify the custom parameters + false + map + 4.19.1 + map + + + diskofferingid + Override root volume's diskoffering. + false + 4.19.1 + uuid + + + expunge + Optional field to expunge old root volume after restore. + false + 4.19.1 + boolean + + + rootdisksize + Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.19.1 + long + + + templateid + 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 + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteNiciraNvpDevice + delete a nicira nvp device + true + + + nvpdeviceid + Nicira device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + notifyBaremetalProvisionDone + Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user + true + + + mac + mac of the nic used for provision + true + object + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUcsBlades + List ucs blades + false + + + ucsmanagerid + ucs manager id + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + ucs blade id + string + + + bladedn + ucs blade dn + string + + + hostid + cloudstack host id this blade associates to + string + + + profiledn + associated ucs profile dn + string + + + ucsmanagerid + ucs manager id + string + + + false + + + getVolumeSnapshotDetails + Get Volume Snapshot Details + false + + + snapshotid + CloudStack Snapshot UUID + true + string + + + + + volumeiScsiName + Volume iSCSI Name + string + + + false + + + updateHost + Updates a host. + false + + + id + the ID of the host to update + true + uuid + + + allocationstate + Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable + false + string + + + annotation + Add an annotation to this host + false + 4.11 + string + + + hosttags + list of tags to be added to the host + false + list + list + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + false + boolean + + + name + Change the name of host + false + 4.15 + string + + + oscategoryid + the id of Os category to update the host with + false + uuid + + + url + the new uri for the secondary storage: nfs://host/path + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createEgressFirewallRule + Creates a egress firewall rule for a given network + true + + + networkid + the network id of the port forwarding rule + true + uuid + + + protocol + the protocol for the firewall rule. Valid values are TCP/UDP/ICMP. + true + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + destcidrlist + the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + startport + the starting port of firewall rule + false + integer + + + type + type of firewallrule: system/user + false + string + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listSecurityGroups + Lists security groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list the security group by the id provided + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + securitygroupname + lists security groups by name + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + lists security groups by virtual machine id + false + uuid + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listOauthProvider + List OAuth providers registered + false + 4.19.0 + + + id + the ID of the OAuth provider + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + Name of the provider + false + string + + + + + id + ID of the provider + string + + + clientid + Client ID registered in the OAuth provider + string + + + description + Description of the provider registered + string + + + enabled + Whether the OAuth provider is enabled or not + boolean + + + name + Name of the provider + string + + + provider + Name of the provider + string + + + redirecturi + Redirect URI registered in the OAuth provider + string + + + secretkey + Secret key registered in the OAuth provider + string + + + false + + + deleteServicePackageOffering + Delete Service Package + false + + + id + the service offering ID + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + destroySystemVm + Destroys a system virtual machine. + true + + + id + The ID of the system virtual machine + true + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + archiveEvents + Archive one or more events. + false + + + enddate + end date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the events + false + list + list + + + startdate + start date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + archive by event type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSecondaryStagingStore + Deletes a secondary staging store . + false + 4.2.0 + + + id + the staging store ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUserData + List registered userdatas + false + 4.18 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the Userdata + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + Userdata name to look for + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the userdata + string + + + accountid + the owner id of the userdata + string + + + domain + the domain name of the userdata owner + string + + + domainid + the domain id of the userdata owner + string + + + domainpath + path of the domain to which the userdata owner belongs + 4.19.2.0 + string + + + name + Name of the userdata + string + + + params + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + string + + + project + the project name of the userdata + 4.19.1 + string + + + projectid + the project id of the userdata + 4.19.1 + string + + + userdata + base64 encoded userdata content + string + + + false + + + updateLoadBalancer + Updates an internal load balancer + true + 4.4.0 + + + id + the ID of the load balancer + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + domainpath + path of the domain to which the Load Balancer belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + scaleSystemVm + Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect. + true + + + id + The ID of the system vm + true + uuid + + + serviceofferingid + the service offering ID to apply to the system vm + true + uuid + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + verifyOAuthCodeAndGetUser + Verify the OAuth Code and fetch the corresponding user from provider + false + 4.19.0 + + + provider + Name of the provider + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + secretcode + Code that is provided by OAuth provider (Eg. google, github) after successful login + false + string + + + + + id + ID of the provider + string + + + clientid + Client ID registered in the OAuth provider + string + + + description + Description of the provider registered + string + + + enabled + Whether the OAuth provider is enabled or not + boolean + + + name + Name of the provider + string + + + provider + Name of the provider + string + + + redirecturi + Redirect URI registered in the OAuth provider + string + + + secretkey + Secret key registered in the OAuth provider + string + + + false + + + listClusterDrsPlan + List DRS plans for a clusters + false + 4.19.0 + + + clusterid + ID of the cluster + false + uuid + + + id + ID of the drs plan + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + unique ID of the drs plan for cluster + string + + + clusterid + Id of the cluster + string + + + eventid + Start event Id of the DRS Plan + string + + + migrations + List of migrations + list + + + status + Status of DRS Plan + status + + + type + Type of DRS Plan (Automated or Manual)) + type + + + false + + + listClusters + Lists clusters. + false + + + allocationstate + lists clusters by allocation state + false + string + + + clustertype + lists clusters by cluster type + false + string + + + hypervisor + lists clusters by hypervisor type + false + string + + + id + lists clusters by the cluster ID + false + uuid + + + keyword + List by keyword + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + name + lists clusters by the cluster name + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists clusters by Pod ID + false + uuid + + + showcapacities + flag to display the capacity of the clusters + false + boolean + + + zoneid + lists clusters by Zone ID + false + uuid + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + listProjectInvitations + Lists project invitations and provides detailed information for listed invitations + false + 3.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + activeonly + if true, list only active invitations - having Pending state and ones that are not timed out yet + false + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list invitations by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list by project id + false + uuid + + + state + list invitations by state + false + string + + + userid + list invitation by user ID + false + uuid + + + + + id + the id of the invitation + string + + + account + the account name of the project's owner + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + domainpath + path of the Domain the project belongs to + 4.19.2.0 + string + + + email + the email the invitation was sent to + string + + + project + the name of the project + string + + + projectid + the id of the project + string + + + state + the invitation state + string + + + userid + the User ID + string + + + false + + + listEgressFirewallRules + Lists all egress firewall rules for network ID. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the firewall services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + the network ID for the egress firewall services + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listClustersMetrics + Lists clusters metrics + false + 4.9.3 + + + allocationstate + lists clusters by allocation state + false + string + + + clustertype + lists clusters by cluster type + false + string + + + hypervisor + lists clusters by hypervisor type + false + string + + + id + lists clusters by the cluster ID + false + uuid + + + keyword + List by keyword + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + name + lists clusters by the cluster name + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists clusters by Pod ID + false + uuid + + + showcapacities + flag to display the capacity of the clusters + false + boolean + + + zoneid + lists clusters by Zone ID + false + uuid + + + + + cpuallocated + the total cpu allocated in Ghz + string + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpumaxdeviation + the maximum cpu deviation + string + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotal + the total cpu capacity in Ghz + string + + + cpuused + the total cpu used in Ghz + string + + + drsimbalance + DRS imbalance for the cluster + string + + + hosts + running / total hosts in the cluster + string + + + memoryallocated + the total cpu allocated in GiB + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorymaxdeviation + the maximum memory deviation + string + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotal + the total cpu capacity in GiB + string + + + memoryused + the total cpu used in GiB + string + + + state + state of the cluster + string + + + false + + + listStoragePoolObjects + Lists objects at specified path on a storage pool. + false + 4.19.0 + + + id + id of the storage pool + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + path to list on storage pool + false + string + + + + + format + Format of template associated with the data store object. + string + + + isdirectory + Is it a directory. + boolean + + + lastupdated + Last modified date of the file/directory. + date + + + name + Name of the data store object. + string + + + size + Size is in Bytes. + long + + + snapshotid + Snapshot ID associated with the data store object. + string + + + templateid + Template ID associated with the data store object. + string + + + volumeid + Volume ID associated with the data store object. + string + + + false + + + createBackupSchedule + Creates a user-defined VM backup schedule + false + 4.14.0 + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + schedule + custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + date + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + listSecondaryStagingStores + Lists secondary staging stores. + false + 4.2.0 + + + id + the ID of the staging store + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the staging store + false + string + + + page + false + integer + + + pagesize + false + integer + + + protocol + the staging store protocol + false + string + + + provider + the staging store provider + false + string + + + zoneid + the Zone ID for the staging store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + startRouter + Starts a router. + true + + + id + the ID of the router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + resetConfiguration + Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings + false + 4.16.0 + + + name + the name of the configuration + true + string + + + accountid + the ID of the Account to reset the parameter value for corresponding account + false + uuid + + + clusterid + the ID of the Cluster to reset the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to reset the parameter value for corresponding domain + false + uuid + + + imagestoreid + the ID of the Image Store to reset the parameter value for corresponding image store + false + uuid + + + storageid + the ID of the Storage pool to reset the parameter value for corresponding storage pool + false + uuid + + + zoneid + the ID of the Zone to reset the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + createAutoScalePolicy + Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group. + true + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + true + string + + + conditionids + the list of IDs of the conditions that are being evaluated on every interval + true + list + list + + + duration + the duration in which the conditions have to be true before action is taken + true + integer + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + quiettime + the cool down period in which the policy should not be evaluated after the action has been taken + false + integer + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + domainpath + path of the domain to which the autoscale policy belongs + 4.19.2.0 + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + deleteStratosphereSsp + Removes stratosphere ssp server + false + + + hostid + the host ID of ssp server + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUsageServerMetrics + Lists Usage Server metrics + false + 4.17.0 + + + + collectiontime + the time these statistics were collected + date + + + hostname + the name of the active usage server + string + + + lastheartbeat + the last time this Usage Server checked for jobs + date + + + lastsuccessfuljob + the last time a usage job successfully completed + date + + + state + the state of the usage server + state + + + false + + + enableHAForZone + Enables HA for a zone + true + 4.11 + + + zoneid + ID of the zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + cleanVMReservations + Cleanups VM reservations in the database. + true + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listObjectStoragePools + Lists object storage pools. + false + 4.19.0 + + + id + the ID of the storage pool + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the object store + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + the object store provider + false + string + + + + + id + the ID of the object store + string + + + name + the name of the object store + string + + + providername + the provider name of the object store + string + + + storagetotal + the total size of the object store + long + + + storageused + the object store currently used size + long + + + url + the url of the object store + string + + + false + + + createSecondaryStagingStore + create secondary staging store. + false + + + url + the URL for the staging store + true + string + + + details + the details for the staging store + false + map + map + + + provider + the staging store provider name + false + string + + + scope + the scope of the staging store: zone only for now + false + string + + + zoneid + the Zone ID for the staging store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + removeVmwareDc + Remove a VMware datacenter from a zone. + false + + + zoneid + The id of Zone from which VMware datacenter has to be removed. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateLBHealthCheckPolicy + Updates load balancer health check policy + true + 4.4 + + + id + ID of load balancer health check policy + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + removeTungstenFabricPolicyRule + remove Tungsten-Fabric policy + true + + + policyuuid + the Uuid of Tungsten-Fabric policy + true + string + + + ruleuuid + the Uuid of Tungsten-Fabric policy rule + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createLoadBalancerRule + Creates a load balancer rule + true + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + true + string + + + name + name of the load balancer rule + true + string + + + privateport + the private port of the private IP address/virtual machine where the network traffic will be load balanced to + true + integer + + + publicport + the public port from where the network traffic will be load balanced from + true + integer + + + account + the account associated with the load balancer. Must be used with the domainId parameter. + false + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed. + false + list + 4.18.0.0 + list + + + description + the description of the load balancer rule + false + string + + + domainid + the domain ID associated with the load balancer + false + uuid + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + networkid + The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case) + false + uuid + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true + false + boolean + + + protocol + The protocol for the LB such as tcp, udp or tcp-proxy. + false + string + + + publicipid + public IP address ID from where the network traffic will be load balanced from + false + uuid + + + zoneid + zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm + false + uuid + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + importVsphereStoragePolicies + Import vSphere storage policies + false + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the Storage Policy + string + + + description + the description of the Storage Policy + string + + + name + the name of the Storage Policy + string + + + policyid + the identifier of the Storage Policy in vSphere DataCenter + string + + + zoneid + the ID of the Zone + string + + + false + + + disableOutOfBandManagementForZone + Disables out-of-band management for a zone + true + 4.9.0 + + + zoneid + the ID of the zone + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + createBackup + Create VM backup + true + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + stopSystemVm + Stops a system VM. + true + + + id + The ID of the system virtual machine + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + updateVPC + Updates a VPC + true + + + id + the id of the VPC + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displaytext + the display text of the VPC + false + string + + + fordisplay + an optional field, whether to the display the vpc to the end user or not + false + 4.4 + boolean + + + name + the name of the VPC + false + string + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC + false + 4.19 + string + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteEgressFirewallRule + Deletes an egress firewall rule + true + + + id + the ID of the firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listIpv6FirewallRules + Lists all IPv6 firewall rules + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + boolean + + + id + Lists ipv6 firewall rule with the specified ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list ipv6 firewall rules by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + list ipv6 firewall rules by traffic type - ingress or egress + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listVMSchedule + List VM Schedules. + false + 4.19.0 + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + action + Action taken by schedule + false + string + + + enabled + ID of VM schedule + false + boolean + + + id + ID of VM schedule + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of VM schedule + string + + + action + Action + action + + + created + Date when the schedule was created + date + + + description + Description of VM schedule + string + + + enabled + VM schedule is enabled + boolean + + + enddate + Date after which the schedule becomes inactive + date + + + schedule + Cron formatted VM schedule + string + + + startdate + Date from which the schedule is active + date + + + timezone + Timezone of the schedule + string + + + virtualmachineid + ID of virtual machine + string + + + false + + + patchSystemVm + Attempts to live patch systemVMs - CPVM, SSVM + true + 4.17.0 + + + forced + If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only + false + boolean + + + id + patches systemVM - CPVM/SSVM with the specified ID + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVolumesMetrics + Lists volume metrics + false + 4.9.3 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster id the disk volume belongs to + false + uuid + + + diskofferingid + list volumes by disk offering + false + 4.4 + uuid + + + displayvolume + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hostid + list volumes on specified host + false + uuid + + + id + the ID of the disk volume + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id + false + list + 4.9 + list + + + isencrypted + list only volumes that are encrypted + false + 4.19.1 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + listsystemvms + list system VMs; only ROOT admin is eligible to pass this parameter + false + 4.18 + boolean + + + name + the name of the disk volume + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod id the disk volume belongs to + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + serviceofferingid + list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored + false + 4.19.1 + uuid + + + state + state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged. + false + string + + + storageid + the ID of the storage pool, available to ROOT admin only + false + 4.3 + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + type + the type of disk volume + false + string + + + virtualmachineid + the ID of the virtual machine + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + diskiopstotal + the total disk iops + long + + + sizegb + disk size in GiB + string + + + false + + + listSslCerts + Lists SSL certificates + false + + + accountid + Account ID + false + uuid + + + certid + ID of SSL certificate + false + uuid + + + lbruleid + Load balancer rule ID + false + uuid + + + projectid + Project that owns the SSL certificate + false + uuid + + + + + id + SSL certificate ID + string + + + account + account for the certificate + string + + + certchain + certificate chain + string + + + certificate + certificate + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + fingerprint + certificate fingerprint + string + + + loadbalancerrulelist + List of loabalancers this certificate is bound to + list + + + name + name + string + + + project + the project name of the certificate + string + + + projectid + the project id of the certificate + string + + + false + + + listDetailOptions + Lists all possible details and their options for a resource type such as a VM or a template + false + 4.13 + + + resourcetype + the resource type such as UserVm, Template etc. + true + string + + + resourceid + the UUID of the resource (optional) + false + string + + + + + details + Map of all possible details and their possible list of values + map + + + false + + + listPrivateGateways + List private gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list private gateway by id + false + uuid + + + ipaddress + list gateways by ip address + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + list gateways by state + false + string + + + vlan + list gateways by vlan + false + string + + + vpcid + list gateways by vpc + false + uuid + + + + + id + the id of the private gateway + string + + + account + the account associated with the private gateway + string + + + aclid + ACL Id set for private gateway + string + + + aclname + ACL name set for private gateway + string + + + domain + the domain associated with the private gateway + string + + + domainid + the ID of the domain associated with the private gateway + string + + + domainpath + path of the domain to which the private gateway belongs + 4.19.2.0 + string + + + gateway + the gateway + string + + + ipaddress + the private gateway's ip address + string + + + netmask + the private gateway's netmask + string + + + physicalnetworkid + the physical network id + string + + + project + the project name of the private gateway + string + + + projectid + the project id of the private gateway + string + + + sourcenatsupported + Source Nat enable status + boolean + + + state + State of the gateway, can be Creating, Ready, Deleting + string + + + vlan + the network implementation uri for the private gateway + string + + + vpcid + VPC id the private gateway belongs to + string + + + vpcname + VPC name the private gateway belongs to + 4.13.2 + string + + + zoneid + zone id of the private gateway + string + + + zonename + the name of the zone the private gateway belongs to + string + + + false + + + updateVmNicIp + Update the default Ip of a VM Nic + true + + + nicid + the ID of the nic to which you want to assign private IP + true + uuid + + + ipaddress + Secondary IP Address + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + startInternalLoadBalancerVM + Starts an existing internal lb vm. + true + + + id + the ID of the internal lb vm + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateDiskOffering + Updates a disk offering. + false + + + id + ID of the disk offering + true + uuid + + + bytesreadrate + bytes read rate of the disk offering + false + 4.15 + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + 4.15 + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + byteswriterate + bytes write rate of the disk offering + false + 4.15 + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + 4.15 + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + cachemode + the cache mode to use for this disk offering + false + 4.15 + string + + + displayoffering + an optional field, whether to display the offering to the end user or not. + false + boolean + + + displaytext + updates alternate display text of the disk offering with this value + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + 4.13 + string + + + iopsreadrate + io requests read rate of the disk offering + false + 4.15 + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + 4.15 + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + iopswriterate + io requests write rate of the disk offering + false + 4.15 + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + 4.15 + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + name + updates name of the disk offering with this value + false + string + + + sortkey + sort key of the disk offering, integer + false + integer + + + state + state of the disk offering + false + string + + + tags + comma-separated list of tags for the disk offering, tags should match with existing storage pool tags + false + 4.15 + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + state + state of the disk offering + string + + + storagetype + the storage type for this disk offering + string + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + removeVirtualMachinesFromKubernetesCluster + Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters. + false + 4.19.0 + + + id + the ID of the Kubernetes cluster + true + uuid + + + virtualmachineids + the IDs of the VMs to remove from the cluster + true + list + list + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the Kubernetes cluster + string + + + false + + + deleteTungstenFabricLogicalRouter + delete Tungsten-Fabric logical router + true + + + logicalrouteruuid + the uuid of Tungsten-Fabric logical router + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listKubernetesClusters + Lists Kubernetes clusters + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged + false + 4.19.0 + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the Kubernetes cluster + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned) + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + state of the Kubernetes cluster + false + string + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + resetVpnConnection + Reset site to site vpn connection + true + + + id + id of vpn connection + true + uuid + + + account + an optional account for connection. Must be used with domainId. + false + string + + + domainid + an optional domainId for connection. If the account parameter is used, domainId must also be used. + false + uuid + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + createAutoScaleVmGroup + Creates and automatically starts a virtual machine based on a service offering, disk offering, and template. + true + + + lbruleid + the ID of the load balancer rule + true + uuid + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + true + integer + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + true + integer + + + scaledownpolicyids + list of scaledown autoscale policies + true + list + list + + + scaleuppolicyids + list of scaleup autoscale policies + true + list + list + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + true + uuid + + + fordisplay + an optional field, whether to the display the group to the end user or not + false + 4.4 + boolean + + + interval + the frequency in which the performance counters to be collected + false + integer + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + deleteLoadBalancerRule + Deletes a load balancer rule. + true + + + id + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addBaremetalPxePingServer + add a baremetal ping pxe server + true + + + password + Credentials to reach external pxe device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + pingdir + Root directory on PING storage server + true + string + + + pingstorageserverip + PING storage server ip + true + string + + + pxeservertype + type of pxe device + true + string + + + tftpdir + Tftp root directory of PXE server + true + string + + + url + URL of the external pxe device + true + string + + + username + Credentials to reach external pxe device + true + string + + + pingcifspassword + Password of PING storage server + false + string + + + pingcifsusername + Username of PING storage server + false + string + + + podid + Pod Id + false + uuid + + + + + pingdir + Root directory on PING storage server + string + + + pingstorageserverip + PING storage server ip + string + + + tftpdir + Tftp root directory of PXE server + string + + + false + + + listPortableIpRanges + list portable IP ranges + false + + + id + Id of the portable ip range + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + regionid + Id of a Region + false + integer + + + + + id + portable IP range ID + string + + + endip + the end ip of the portable IP range + string + + + gateway + the gateway of the VLAN IP range + string + + + netmask + the netmask of the VLAN IP range + string + + + regionid + Region Id in which portable ip range is provisioned + integer + + + startip + the start ip of the portable IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + portableipaddress(*) + List of portable IP and association with zone/network/vpc details that are part of GSLB rule + + + accountid + the account ID the portable IP address is associated with + string + + + allocated + date the portal IP address was acquired + date + + + domainid + the domain ID the portable IP address is associated with + string + + + ipaddress + public IP address + string + + + networkid + the ID of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + regionid + Region Id in which global load balancer is created + integer + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing and Free + string + + + vpcid + VPC the ip belongs to + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + list + + + false + + + getVirtualMachineUserData + Returns user data associated with the VM + false + 4.4 + + + virtualmachineid + The ID of the virtual machine + true + uuid + + + + + userdata + Base64 encoded VM user data + string + + + virtualmachineid + the ID of the virtual machine + string + + + false + + + createNetworkPermissions + Updates network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + accountids + a comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + accounts + a comma delimited list of accounts within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + projectids + a comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addIpToNic + Assigns secondary IP to NIC + true + + + nicid + the ID of the nic to which you want to assign private IP + true + uuid + + + ipaddress + Secondary IP Address + false + string + + + + + id + the ID of the secondary private IP addr + string + + + ipaddress + Secondary IP address + string + + + networkid + the ID of the network + string + + + nicid + the ID of the nic + string + + + secondaryip + the list of Secondary ipv4 addr of nic + list + + + virtualmachineid + the ID of the vm + string + + + false + + + quotaTariffUpdate + Update the tariff plan for a resource + false + 4.7.0 + + + name + Quota tariff's name + true + 4.18.0.0 + string + + + activationrule + Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule. + false + 4.18.0.0 + string + + + description + Quota tariff's description. Inform empty to remove the description. + false + 4.18.0.0 + string + + + enddate + The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2009-06-03. + false + 4.18.0.0 + date + + + startdate + DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + usagetype + DEPRECATED. Integer value for the usage type of the resource + false + integer + + + value + The quota tariff value of the resource as per the default unit. + false + double + + + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + uuid + uuid + string + + + false + + + disableStaticNat + Disables static rule for given IP address + true + + + ipaddressid + the public IP address ID for which static NAT feature is being disabled + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteUcsManager + Delete a Ucs manager + false + + + ucsmanagerid + ucs manager id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteHost + Deletes a host. + false + + + id + the host ID + true + uuid + + + forced + Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped + false + boolean + + + forcedestroylocalstorage + Force destroy local storage on this host. All VMs created on this local storage will be destroyed + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteResourceIcon + deletes the resource icon from the specified resource(s) + false + 4.16.0.0 + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listCapabilities + Lists capabilities + false + + + + allowusercreateprojects + true if regular user is allowed to create projects + boolean + + + allowuserexpungerecovervm + true if the user can recover and expunge virtualmachines, false otherwise + 4.6.0 + boolean + + + allowuserexpungerecovervolume + true if the user can recover and expunge volumes, false otherwise + 4.14.0 + boolean + + + allowuserviewalldomainaccounts + true if users can see all accounts within the same domain, false otherwise + boolean + + + allowuserviewdestroyedvm + true if the user is allowed to view destroyed virtualmachines, false otherwise + 4.6.0 + boolean + + + apilimitinterval + time interval (in seconds) to reset api count + integer + + + apilimitmax + Max allowed number of api requests within the specified interval + integer + + + cloudstackversion + version of the cloud stack + string + + + customdiskofferingmaxsize + maximum size that can be specified when create disk from disk offering with custom size + long + + + customdiskofferingminsize + minimum size that can be specified when create disk from disk offering with custom size + long + + + customhypervisordisplayname + Display name for custom hypervisor + 4.19.0 + string + + + defaultuipagesize + default page size in the UI for various views, value set in the configurations + 4.15.2 + long + + + dynamicrolesenabled + true if dynamic role-based api checker is enabled, false otherwise + boolean + + + instancesdisksstatsretentionenabled + true if stats are retained for instance disks otherwise false + 4.18.0 + boolean + + + instancesdisksstatsretentiontime + the retention time for Instances disks stats + 4.18.0 + integer + + + instancesstatsretentiontime + the retention time for Instances stats + 4.18.0 + integer + + + instancesstatsuseronly + true if stats are collected only for user instances, false if system instance stats are also collected + 4.18.0 + boolean + + + kubernetesclusterexperimentalfeaturesenabled + true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise + boolean + + + kubernetesserviceenabled + true if Kubernetes Service plugin is enabled, false otherwise + boolean + + + kvmsnapshotenabled + true if snapshot is supported for KVM host, false otherwise + boolean + + + projectinviterequired + If invitation confirmation is required when add account to project + boolean + + + regionsecondaryenabled + true if region wide secondary is enabled, false otherwise + boolean + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + supportELB + true if region supports elastic load balancer on basic zones + string + + + userpublictemplateenabled + true if user and domain admins can set templates to be shared, false otherwise + boolean + + + false + + + releaseDedicatedZone + Release dedication of zone + true + + + zoneid + the ID of the Zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + checkVolume + Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only + true + 4.19.1 + + + id + The ID of the volume + true + uuid + + + repair + parameter to repair the volume, leaks or all are the possible values + false + string + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateNetworkServiceProvider + Updates a network serviceProvider of a physical network + true + 3.0.0 + + + id + network service provider id + true + uuid + + + servicelist + the list of services to be enabled for this physical network service provider + false + list + list + + + state + Enabled/Disabled/Shutdown the physical network service provider + false + string + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + listManagementServersMetrics + Lists Management Server metrics + false + 4.17.0 + + + id + the id of the management server + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the management server + false + string + + + page + false + integer + + + pagesize + false + integer + + + system + include system level stats + false + boolean + + + + + agentcount + the number of agents this Management Server is responsible for + integer + + + availableprocessors + the number of processors available to the JVM + integer + + + collectiontime + the time these statistics were collected + date + + + cpuload + the current cpu load + string + + + dbislocal + the system is running against a local database + boolean + + + heapmemorytotal + the amount of memory allocated to this Management Server + long + + + heapmemoryused + the amount of memory used by this Management Server + long + + + loginfo + the log files and their usage on disk + string + + + sessions + the number of client sessions active on this Management Server + long + + + systemcycleusage + the system load for user, and system processes and the system idle cycles + long[] + + + systemloadaverages + the load averages for 1 5 and 15 minutes + double[] + + + systemmemoryfree + Free system memory + string + + + systemmemorytotal + Total system memory + string + + + systemmemoryused + Amount of memory used + string + + + systemmemoryvirtualsize + Virtual size of the fully loaded process + string + + + systemtotalcpucycles + the total system cpu capacity + double + + + threadsblockedcount + The number of blocked threads + integer + + + threadsdaemoncount + The number of daemon threads + integer + + + threadsrunnablecount + The number of runnable threads + integer + + + threadsteminatedcount + The number of terminated threads + integer + + + threadstotalcount + The number of threads + integer + + + threadswaitingcount + The number of waiting threads + integer + + + usageislocal + the system has a usage server running locally + boolean + + + false + + + listInstanceGroups + Lists vm groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list instance groups by ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list instance groups by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + domainpath + path of the Domain the instance group belongs to + 4.19.2.0 + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + removeFromLoadBalancerRule + Removes a virtual machine or a list of virtual machines from a load balancer rule. + true + + + id + The ID of the load balancer rule + true + uuid + + + virtualmachineids + the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3) + false + list + list + + + vmidipmap + VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75 + false + map + 4.4 + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createStaticRoute + Creates a static route + true + + + cidr + static route cidr + true + string + + + gatewayid + the gateway id we are creating static route for + true + uuid + + + + + id + the ID of static route + string + + + account + the account associated with the static route + string + + + cidr + static route CIDR + string + + + domain + the domain associated with the static route + string + + + domainid + the ID of the domain associated with the static route + string + + + domainpath + the domain path associated with the static route + 4.19.2.0 + string + + + gatewayid + VPC gateway the route is created for + string + + + project + the project name of the static route + string + + + projectid + the project id of the static route + string + + + state + the state of the static route + string + + + vpcid + VPC the static route belongs to + string + + + tags(*) + the list of resource tags associated with static route + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deletePrivateGateway + Deletes a Private gateway + true + + + id + the ID of the private gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateDomain + Updates a domain with a new name + false + + + id + ID of domain to update + true + uuid + + + name + updates domain with this name + false + string + + + networkdomain + Network domain for the domain's networks; empty string will update domainName with NULL value + false + string + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + disableAutoScaleVmGroup + Disables an AutoScale Vm Group + true + + + id + the ID of the autoscale group + true + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + createSnapshotPolicy + Creates a snapshot policy for the account. + false + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + maxsnaps + maximum number of snapshots to retain + true + integer + + + schedule + time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + true + string + + + volumeid + the ID of the disk volume + true + uuid + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + tags + Map of tags (key/value pairs) + false + map + map + + + zoneids + A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present. + false + list + list + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + zone + The list of zones in which snapshot backup is scheduled + 4.19.0 + set + + + false + + + disableHAForZone + Disables HA for a zone + true + 4.11 + + + zoneid + ID of the zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + unmanageVolume + Unmanage a volume on storage pool. + true + 4.19.1 + + + id + The ID of the volume to unmanage + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSystemVms + List system virtual machines. + false + + + hostid + the host ID of the system VM + false + uuid + + + id + the ID of the system VM + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the system VM + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the system VM + false + uuid + + + state + the state of the system VM + false + string + + + storageid + the storage ID where vm's volumes belong to + false + 3.0.1 + uuid + + + systemvmtype + the system VM type. Possible types are "consoleproxy" and "secondarystoragevm". + false + string + + + zoneid + the Zone ID of the system VM + false + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + createRolePermission + Adds an API permission to a role + false + 4.9.0 + + + permission + The rule permission, allow or deny. Default: deny. + true + string + + + roleid + ID of the role + true + uuid + + + rule + The API name or wildcard rule such as list* + true + string + + + description + The description of the role permission + false + string + + + + + id + the ID of the role permission + string + + + roleid + the ID of the role to which the role permission belongs + string + + + rolename + the name of the role to which the role permission belongs + string + + + false + + + detachVolume + Detaches a disk volume from a virtual machine. + true + + + deviceid + the device ID on the virtual machine where volume is detached from + false + long + + + id + the ID of the disk volume + false + uuid + + + virtualmachineid + the ID of the virtual machine where the volume is detached from + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + replaceNetworkACLList + Replaces ACL associated with a network or private gateway + true + + + aclid + the ID of the network ACL + true + uuid + + + gatewayid + the ID of the private gateway + false + uuid + + + networkid + the ID of the network + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricAddressGroup + list Tungsten-Fabric address group + false + + + addressgroupuuid + the uuid of Tungsten-Fabric address group + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + ipprefix + Tungsten-Fabric address group ip prefix + string + + + ipprefixlen + Tungsten-Fabric address group ip prefix length + int + + + name + Tungsten-Fabric address group name + string + + + uuid + Tungsten-Fabric address group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + enableOutOfBandManagementForZone + Enables out-of-band management for a zone + true + 4.9.0 + + + zoneid + the ID of the zone + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listLdapUsers + Lists LDAP Users according to the specifications from the user request. + false + 4.2.0 + + + domainid + linked domain + false + uuid + + + keyword + List by keyword + false + string + + + listtype + Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter + false + string + + + page + false + integer + + + pagesize + false + integer + + + userfilter + Determines what type of filter is applied on the list of users returned from LDAP. + valid values are + 'NoFilter' no filtering is done, + 'LocalDomain' users already in the current or requested domain will be filtered out of the result list, + 'AnyDomain' users that already exist anywhere in cloudstack will be filtered out, and + 'PotentialImport' all users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource + false + 4.13 + string + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + createVMSchedule + Create VM Schedule + false + 4.19.0 + + + action + Action to take on the VM (start/stop/restart/force_stop/force_reboot). + true + string + + + schedule + Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month' + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + description + Description of the schedule + false + string + + + enabled + Enable VM schedule. Defaults to true + false + boolean + + + enddate + end date after which the schedule becomes inactiveUse format "yyyy-MM-dd hh:mm:ss") + false + date + + + startdate + start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of VM schedule + string + + + action + Action + action + + + created + Date when the schedule was created + date + + + description + Description of VM schedule + string + + + enabled + VM schedule is enabled + boolean + + + enddate + Date after which the schedule becomes inactive + date + + + schedule + Cron formatted VM schedule + string + + + startdate + Date from which the schedule is active + date + + + timezone + Timezone of the schedule + string + + + virtualmachineid + ID of virtual machine + string + + + false + + + listIpForwardingRules + List the IP forwarding rules + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + list the rule belonging to this public IP address + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + virtualmachineid + Lists all rules applied to the specified VM. + false + uuid + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createSnapshot + Creates an instant snapshot of a volume. + true + + + volumeid + The ID of the disk volume + true + uuid + + + account + The account of the snapshot. The account parameter must be used with the domainId parameter. + false + string + + + asyncbackup + asynchronous backup if true + false + boolean + + + domainid + The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain. + false + uuid + + + locationtype + Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'. + false + string + + + name + the name of the snapshot + false + string + + + policyid + policy id of the snapshot, if this is null, then use MANUAL_POLICY. + false + uuid + + + quiescevm + quiesce vm if true + false + boolean + + + tags + Map of tags (key/value pairs) + false + map + map + + + zoneids + A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. + false + list + 4.19.0 + list + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listStoragePoolsMetrics + Lists storage pool metrics + false + 4.9.3 + + + clusterid + list storage pools belongig to the specific cluster + false + uuid + + + hostid + host ID of the storage pools + false + uuid + + + id + the ID of the storage pool + false + uuid + + + ipaddress + the IP address for the storage pool + false + string + + + keyword + List by keyword + false + string + + + name + the name of the storage pool + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the storage pool path + false + string + + + podid + the Pod ID for the storage pool + false + uuid + + + scope + the scope of the storage pool + false + string + + + status + the status of the storage pool + false + string + + + storagecustomstats + If true, lists the custom stats of the storage pool + false + 4.18.1 + boolean + + + zoneid + the Zone ID for the storage pool + false + uuid + + + + + disksizeallocatedgb + disk size allocated in GiB + string + + + disksizetotalgb + disk size in GiB + string + + + disksizeunallocatedgb + disk size unallocated in GiB + string + + + disksizeusedgb + disk size used in GiB + string + + + storageallocateddisablethreshold + storage allocated disable threshold exceeded + boolean + + + storageallocatedthreshold + storage allocated notification threshold exceeded + boolean + + + storageusagedisablethreshold + storage usage disable threshold exceeded + boolean + + + storageusagethreshold + storage usage notification threshold exceeded + boolean + + + false + + + deleteBackupOffering + Deletes a backup offering + false + 4.14.0 + + + id + ID of the backup offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createSSHKeyPair + Create a new keypair and returns the private key + false + + + name + Name of the keypair + true + string + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the ssh key. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the ssh key + false + uuid + + + + + privatekey + Private key + string + + + false + + + listTungstenFabricServiceGroup + list Tungsten-Fabric service group + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + servicegroupuuid + the uuid of Tungsten-Fabric service group + false + string + + + zoneid + the ID of zone + false + uuid + + + + + endport + Tungsten-Fabric service group end port + int + + + name + Tungsten-Fabric service group name + string + + + protocol + Tungsten-Fabric service group protocol + string + + + startport + Tungsten-Fabric service group start port + int + + + uuid + Tungsten-Fabric service group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + authorizeSecurityGroupEgress + Authorizes a particular egress rule for this security group + true + 3.0.0 + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + cidrlist + the cidr list associated. Multiple entries must be separated by a single comma character (,). + false + list + list + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + endport + end port for this egress rule + false + integer + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + projectid + an optional project of the security group + false + uuid + + + protocol + TCP is default. UDP is the other supported protocol + false + string + + + securitygroupid + The ID of the security group. Mutually exclusive with securityGroupName parameter + false + uuid + + + securitygroupname + The name of the security group. Mutually exclusive with securityGroupId parameter + false + string + + + startport + start port for this egress rule + false + integer + + + usersecuritygrouplist + user to security group mapping + false + map + map + + + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listStoragePools + Lists storage pools. + false + + + clusterid + list storage pools belongig to the specific cluster + false + uuid + + + hostid + host ID of the storage pools + false + uuid + + + id + the ID of the storage pool + false + uuid + + + ipaddress + the IP address for the storage pool + false + string + + + keyword + List by keyword + false + string + + + name + the name of the storage pool + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the storage pool path + false + string + + + podid + the Pod ID for the storage pool + false + uuid + + + scope + the scope of the storage pool + false + string + + + status + the status of the storage pool + false + string + + + storagecustomstats + If true, lists the custom stats of the storage pool + false + 4.18.1 + boolean + + + zoneid + the Zone ID for the storage pool + false + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateHypervisorCapabilities + Updates a hypervisor capabilities. + false + 3.0.0 + + + hypervisor + the hypervisor for which the hypervisor capabilities are to be updated + false + 4.19.1 + string + + + hypervisorversion + the hypervisor version for which the hypervisor capabilities are to be updated + false + 4.19.1 + string + + + id + ID of the hypervisor capability + false + uuid + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached to a VM for this hypervisor. + false + 4.16.0 + integer + + + maxguestslimit + the max number of Guest VMs per host for this hypervisor. + false + long + + + maxhostspercluster + the maximum number of the hypervisor hosts per cluster + false + 4.16.0 + integer + + + securitygroupenabled + set true to enable security group for this hypervisor. + false + boolean + + + storagemotionenabled + set true to enable storage motion support for this hypervisor + false + 4.16.0 + boolean + + + vmsnapshotenabled + set true to enable VM snapshots for this hypervisor + false + 4.16.0 + boolean + + + + + id + the ID of the hypervisor capabilities row + string + + + hypervisor + the hypervisor type + string + + + hypervisorversion + the hypervisor version + string + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached for this hypervisor + integer + + + maxguestslimit + the maximum number of guest vms recommended for this hypervisor + long + + + maxhostspercluster + the maximum number of Hosts per cluster for this hypervisor + integer + + + securitygroupenabled + true if security group is supported + boolean + + + storagemotionenabled + true if storage motion is supported + boolean + + + vmsnapshotenabled + true if VM snapshots are enabled for this hypervisor + boolean + + + false + + + enableCiscoNexusVSM + Enable a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be enabled + true + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + findHostsForMigration + Find hosts suitable for migrating a virtual machine. + false + + + virtualmachineid + find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the host + string + + + averageload + the cpu average load on the host + long + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpunumber + the CPU number of the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + long + + + memoryallocated + the amount of the host's memory currently allocated + string + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + requiresStorageMotion + true if migrating a vm to this host requires storage motion, false otherwise + boolean + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + false + + + isAccountAllowedToCreateOfferingsWithTags + Return true if the specified account is allowed to create offerings with tags. + false + + + id + Account UUID + false + uuid + + + + + isallowed + is domain admin allowed to create offerings with tags + boolean + + + false + + + addNicToVirtualMachine + Adds VM to specified network by creating a NIC + true + + + networkid + Network ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + dhcpoptions + DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com + false + map + map + + + ipaddress + IP Address for the new network + false + string + + + macaddress + Mac Address for the new network + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listStaticRoutes + Lists all static routes + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + gatewayid + list static routes by gateway id + false + uuid + + + id + list static route by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + list static routes by state + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vpcid + list static routes by vpc id + false + uuid + + + + + id + the ID of static route + string + + + account + the account associated with the static route + string + + + cidr + static route CIDR + string + + + domain + the domain associated with the static route + string + + + domainid + the ID of the domain associated with the static route + string + + + domainpath + the domain path associated with the static route + 4.19.2.0 + string + + + gatewayid + VPC gateway the route is created for + string + + + project + the project name of the static route + string + + + projectid + the project id of the static route + string + + + state + the state of the static route + string + + + vpcid + VPC the static route belongs to + string + + + tags(*) + the list of resource tags associated with static route + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getSPMetadata + Returns SAML2 CloudStack Service Provider MetaData + false + + + + metadata + The Metadata XML + string + + + false + + + listPublicIpAddresses + Lists all public ip addresses + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + allocatedonly + limits search results to allocated public IP addresses + false + boolean + + + associatednetworkid + lists all public IP addresses associated to the network specified + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + forloadbalancing + list only IPs used for load balancing + false + boolean + + + forvirtualnetwork + the virtual network for the IP address + false + boolean + + + id + lists IP address by ID + false + uuid + + + ipaddress + lists the specified IP address + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issourcenat + list only source NAT IP addresses + false + boolean + + + isstaticnat + list only static NAT IP addresses + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + lists all public IP addresses by source network ID + false + 4.13.0 + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + lists all public IP addresses by physical network ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + state + lists all public IP addresses by state + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vlanid + lists all public IP addresses by VLAN ID + false + uuid + + + vpcid + List IPs belonging to the VPC + false + uuid + + + zoneid + lists all public IP addresses by zone ID + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listOpenDaylightControllers + Lists OpenDyalight controllers + false + + + id + the ID of a OpenDaylight Controller + false + uuid + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + addBigSwitchBcfDevice + Adds a BigSwitch BCF Controller device + true + 4.6.0 + + + hostname + Hostname of ip address of the BigSwitch BCF Controller. + true + string + + + nat + NAT support of the BigSwitch BCF Controller. + true + boolean + + + password + Password of the BigSwitch BCF Controller. + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Username of the BigSwitch BCF Controller. + true + string + + + + + bcfdeviceid + device id of the BigSwitch BCF Controller + string + + + bigswitchdevicename + device name + string + + + hostname + the controller Ip address + string + + + nat + NAT support + boolean + + + password + the controller password + string + + + physicalnetworkid + the physical network to which this BigSwitch BCF segment belongs to + string + + + provider + name of the provider + string + + + username + the controller username + string + + + false + + + updateDefaultNicForVirtualMachine + Changes the default NIC on a VM + true + + + nicid + NIC ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + generateClusterDrsPlan + Generate DRS plan for a cluster + false + 4.19.0 + + + id + the ID of the Cluster + true + uuid + + + migrations + Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting + false + integer + + + + + id + unique ID of the drs plan for cluster + string + + + clusterid + Id of the cluster + string + + + eventid + Start event Id of the DRS Plan + string + + + migrations + List of migrations + list + + + status + Status of DRS Plan + status + + + type + Type of DRS Plan (Automated or Manual)) + type + + + false + + + issueOutOfBandManagementPowerAction + Initiates the specified power action to the host's out-of-band management interface + true + 4.9.0 + + + action + out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS + true + string + + + hostid + the ID of the host + true + uuid + + + timeout + optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting + false + long + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + deleteUser + Deletes a user for an account + false + + + id + id of the user to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkDevice + Deletes network device. + false + + + id + Id of network device to delete + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateImageStore + Updates image store read-only status + false + 4.15.0 + + + id + Image Store UUID + true + uuid + + + capacitybytes + The number of bytes CloudStack can use on this image storage. + NOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage. + false + long + + + name + The new name for the Image Store. + false + string + + + readonly + If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration + false + boolean + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + assignToLoadBalancerRule + Assigns virtual machine or a list of virtual machines to a load balancer rule. + true + + + id + the ID of the load balancer rule + true + uuid + + + virtualmachineids + the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3) + false + list + list + + + vmidipmap + VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75 + false + map + 4.4 + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAsyncJobs + Lists all pending asynchronous jobs for the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + managementserverid + The id of the management server + false + 4.19 + uuid + + + page + false + integer + + + pagesize + false + integer + + + startdate + The start date of the async job (use format "yyyy-MM-dd'T'HH:mm:ss'+'SSSS") + false + date + + + + + account + the account that executed the async command + string + + + accountid + the account id that executed the async command + string + + + cmd + the async command executed + string + + + completed + the completed date of the job + date + + + created + the created date of the job + date + + + domainid + the domain id that executed the async command + string + + + domainpath + the domain that executed the async command + string + + + jobinstanceid + the unique ID of the instance/entity object related to the job + string + + + jobinstancetype + the instance/entity object related to the job + string + + + jobprocstatus + the progress information of the PENDING job + integer + + + jobresult + the result reason + responseobject + + + jobresultcode + the result code for the job + integer + + + jobresulttype + the result type + string + + + jobstatus + the current job status-should be 0 for PENDING + integer + + + managementserverid + the msid of the management server on which the job is running + 4.19 + long + + + userid + the user that executed the async command + string + + + jobid + the ID of the async job + + + false + + + archiveAlerts + Archive one or more alerts. + false + + + enddate + end date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the alerts + false + list + list + + + startdate + start date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + archive by alert type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteCiscoVnmcResource + Deletes a Cisco Vnmc controller + false + + + resourceid + Cisco Vnmc resource ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createSecondaryStorageSelector + Creates a secondary storage selector, described by the heuristic rule. + false + 4.19.0 + + + description + The description of the heuristic rule. + true + string + + + heuristicrule + The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID. + true + string + + + name + The name identifying the heuristic rule. + true + string + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + true + string + + + zoneid + The zone in which the heuristic rule will be applied. + true + uuid + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + addBrocadeVcsDevice + Adds a Brocade VCS Switch + true + + + hostname + Hostname of ip address of the Brocade VCS Switch. + true + string + + + password + Credentials to access the Brocade VCS Switch API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Credentials to access the Brocade VCS Switch API + true + string + + + + + brocadedevicename + device name + string + + + hostname + the principal switch Ip address + string + + + physicalnetworkid + the physical Network to which this Brocade VCS belongs to + string + + + provider + name of the provider + string + + + vcsdeviceid + device id of the Brocade Vcs + string + + + false + + + deleteTags + Deleting resource tag(s) + true + 4.0.0 + + + resourceids + Delete tags for resource id(s) + true + list + list + + + resourcetype + Delete tag by resource type + true + string + + + tags + Delete tags matching key/value pairs + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricTagType + create Tungsten-Fabric tag type + true + + + name + Tungsten-Fabric tag type name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric tag type name + string + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + login + Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired. + false + + + password + Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Username + true + string + + + domain + Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed. + false + string + + + domainId + The id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precedence. + false + long + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + restartNetwork + Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules + true + + + id + The ID of the network to restart. + true + uuid + + + cleanup + If cleanup old network elements + false + boolean + + + livepatch + Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false. + false + 4.17.0 + boolean + + + makeredundant + Turn the network into a network with redundant routers. + false + 4.11.1 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listHypervisorCapabilities + Lists all hypervisor capabilities. + false + 3.0.0 + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + ID of the hypervisor capability + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the hypervisor capabilities row + string + + + hypervisor + the hypervisor type + string + + + hypervisorversion + the hypervisor version + string + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached for this hypervisor + integer + + + maxguestslimit + the maximum number of guest vms recommended for this hypervisor + long + + + maxhostspercluster + the maximum number of Hosts per cluster for this hypervisor + integer + + + securitygroupenabled + true if security group is supported + boolean + + + storagemotionenabled + true if storage motion is supported + boolean + + + vmsnapshotenabled + true if VM snapshots are enabled for this hypervisor + boolean + + + false + + + deleteProjectRole + Delete Project roles in CloudStack + false + 4.15.0 + + + id + ID of the project role to be deleted + true + uuid + + + projectid + ID of the project from where the role is to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getSolidFireAccountId + Get SolidFire Account ID + false + + + accountid + CloudStack Account UUID + true + string + + + storageid + Storage Pool UUID + true + string + + + + + solidFireAccountId + SolidFire Account ID + long + + + false + + + quotaBalance + Create a quota balance statement + false + 4.7.0 + + + account + Account Id for which statement needs to be generated + true + string + + + domainid + If domain Id is given and the caller is domain admin then the statement is generated for domain. + true + uuid + + + accountid + List usage records for the specified account + false + uuid + + + enddate + End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + startdate + Start date range quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + false + date + + + + + account + account name + string + + + accountid + account id + long + + + domain + domain id + long + + + name + usage type name + string + + + quota + quota consumed + bigdecimal + + + type + usage type + int + + + unit + usage unit + string + + + false + + + listRolePermissions + Lists role permissions + false + 4.9.0 + + + roleid + ID of the role + false + uuid + + + + + id + the ID of the role permission + string + + + roleid + the ID of the role to which the role permission belongs + string + + + rolename + the name of the role to which the role permission belongs + string + + + false + + + listDedicatedGuestVlanRanges + Lists dedicated guest vlan ranges + false + + + account + the account with which the guest VLAN range is associated. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain. + false + uuid + + + guestvlanrange + the dedicated guest vlan range + false + string + + + id + list dedicated guest vlan ranges by id + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + physical network id of the guest VLAN range + false + uuid + + + projectid + project who will own the guest VLAN range + false + uuid + + + zoneid + zone of the guest VLAN range + false + uuid + + + + + id + the ID of the guest VLAN range + string + + + account + the account of the guest VLAN range + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + domainpath + path of the domain to which the guest VLAN range belongs + 4.19.2.0 + string + + + guestvlanrange + the guest VLAN range + string + + + physicalnetworkid + the physical network of the guest vlan range + long + + + project + the project name of the guest vlan range + string + + + projectid + the project id of the guest vlan range + string + + + zoneid + the zone of the guest vlan range + long + + + false + + + listNetworkACLs + Lists all network ACL items + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + aclid + list network ACL items by ACL ID + false + uuid + + + action + list network ACL items by action + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists network ACL Item with the specified ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list network ACL items by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + protocol + list network ACL items by protocol + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + list network ACL items by traffic type - ingress or egress + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + copyTemplate + Copies a template from one zone to another. + true + + + id + Template ID. + true + uuid + + + destzoneid + ID of the zone the template is being copied to. + false + uuid + + + destzoneids + 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. + false + list + list + + + sourcezoneid + 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. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listNiciraNvpDeviceNetworks + lists network that are using a nicira nvp device + false + + + nvpdeviceid + nicira nvp device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteBigSwitchBcfDevice + delete a BigSwitch BCF Controller device + true + 4.6.0 + + + bcfdeviceid + BigSwitch device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listOvsElements + Lists all available ovs elements. + false + + + enabled + list network offerings by enabled state + false + boolean + + + id + list ovs elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list ovs elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the ovs + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + associateUcsProfileToBlade + associate a profile to a blade + true + + + bladeid + blade id + true + uuid + + + profiledn + profile dn + true + string + + + ucsmanagerid + ucs manager id + true + uuid + + + + + id + ucs blade id + string + + + bladedn + ucs blade dn + string + + + hostid + cloudstack host id this blade associates to + string + + + profiledn + associated ucs profile dn + string + + + ucsmanagerid + ucs manager id + string + + + false + + + validateUserTwoFactorAuthenticationCode + Checks the 2FA code for the user. + false + 4.18.0 + + + codefor2fa + two factor authentication code + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateVmwareDc + Updates a VMware datacenter details for a zone + false + 4.12.0 + + + zoneid + The zone ID + true + uuid + + + isrecursive + Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true. + false + boolean + + + name + VMware datacenter name. + false + string + + + password + The password for specified username. + false + string + + + username + The username required to connect to resource. + false + string + + + vcenter + The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + listNetscalerControlCenter + list control center + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + id + string + + + ipaddress + ncc_ip + string + + + numretries + num_retries + string + + + username + username + string + + + uuid + uuid + string + + + false + + + getRouterHealthCheckResults + Starts a router. + false + 4.14.0 + + + routerid + the ID of the router + true + uuid + + + performfreshchecks + if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched + false + boolean + + + + + healthchecks + the id of the router + list + + + routerid + the id of the router + string + + + false + + + resizeVolume + Resizes a volume + true + + + id + the ID of the disk volume + true + uuid + + + diskofferingid + new disk offering id + false + uuid + + + maxiops + New maximum number of IOPS + false + long + + + miniops + New minimum number of IOPS + false + long + + + shrinkok + Verify OK to Shrink + false + boolean + + + size + New volume size in GB + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteAffinityGroup + Deletes affinity group + true + + + account + the account of the affinity group. Must be specified with domain ID + false + string + + + domainid + the domain ID of account owning the affinity group + false + uuid + + + id + The ID of the affinity group. Mutually exclusive with name parameter + false + uuid + + + name + The name of the affinity group. Mutually exclusive with ID parameter + false + string + + + projectid + the project of the affinity group + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkOffering + Deletes a network offering. + false + 3.0.0 + + + id + the ID of the network offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + dedicatePod + Dedicates a Pod. + true + + + domainid + the ID of the containing domain + true + uuid + + + podid + the ID of the Pod + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Pod is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the pod + string + + + domainid + the domain ID to which the Pod is dedicated + string + + + podid + the ID of the Pod + string + + + podname + the Name of the Pod + string + + + false + + + updateStorageNetworkIpRange + Update a Storage network IP range, only allowed when no IPs in this range have been allocated. + true + 3.0.0 + + + id + UUID of storage network ip range + true + uuid + + + endip + the ending IP address + false + string + + + netmask + the netmask for storage network + false + string + + + startip + the beginning IP address + false + string + + + vlan + Optional. the vlan the ip range sits on + false + integer + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + synchronizeTungstenFabricData + Synchronize Tungsten-Fabric data + false + + + id + provider id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + changeOfferingForVolume + Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering + true + 4.17 + + + id + the ID of the volume + true + uuid + + + diskofferingid + new disk offering id + true + uuid + + + automigrate + Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering + false + boolean + + + maxiops + New maximum number of IOPS for the custom disk offering + false + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + long + + + shrinkok + Verify OK to Shrink + false + boolean + + + size + New volume size in GB for the custom disk offering + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteLdapConfiguration + Remove an Ldap Configuration + false + 4.2.0 + + + hostname + Hostname + true + string + + + domainid + linked domain + false + uuid + + + port + port + false + integer + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port the ldap server is running on + int + + + false + + + createProjectRole + Creates a Project role + false + 4.15.0 + + + name + creates a project role with this unique name + true + string + + + projectid + ID of project where role is being created + true + uuid + + + description + The description of the Project role + false + string + + + + + projectid + the id of the project + string + + + false + + + createIpv6FirewallRule + Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC) + true + + + networkid + The network of the VM the Ipv6 firewall rule will be created for + true + uuid + + + protocol + the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + true + string + + + cidrlist + the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + destcidrlist + the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of Ipv6 firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + startport + the starting port of Ipv6 firewall rule + false + integer + + + traffictype + the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + triggerShutdown + Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced + false + 4.19.0 + + + managementserverid + the uuid of the management server + true + uuid + + + + + managementserverid + The id of the management server + long + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + updateNetwork + Updates a network + true + + + id + the ID of the network + true + uuid + + + changecidr + Force update even if CIDR type is different + false + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + false + boolean + + + displaytext + the new display text for the network + false + string + + + dns1 + the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone + false + 4.18.0 + string + + + forced + Setting this to true will cause a forced network update, + false + boolean + + + guestvmcidr + CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR + false + string + + + hideipaddressusage + when true ip address usage for the network will not be exported by the listUsageRecords API + false + boolean + + + ip6dns1 + the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone + false + 4.18.0 + string + + + name + the new name for the network + false + string + + + networkdomain + network domain + false + string + + + networkofferingid + network offering ID + false + uuid + + + privatemtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network + false + 4.19 + string + + + updateinsequence + if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider + false + boolean + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listBackups + Lists VM backups + false + 4.14.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + id of the backup + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + virtualmachineid + id of the VM + false + uuid + + + zoneid + list backups by zone id + false + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + date + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + listUsageTypes + List Usage Types + false + + + + description + description of usage type + string + + + usagetypeid + usage type + integer + + + false + + + listBackupProviders + Lists Backup and Recovery providers + false + 4.14.0 + + + name + List Backup and Recovery provider by name + false + string + + + + + description + the description of the CA service provider + string + + + name + the CA service provider name + string + + + false + + + deleteVPC + Deletes a VPC + true + + + id + the ID of the VPC + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateVirtualMachine + Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default + false + 4.16.0 + boolean + + + hostid + Destination Host ID to migrate VM to. + false + uuid + + + storageid + Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteKubernetesSupportedVersion + Deletes a Kubernetes cluster + true + + + id + the ID of the Kubernetes supported version + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBaremetalRct + list baremetal rack configuration + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + id of rct + string + + + url + url + string + + + false + + + listCAProviders + Lists available certificate authority providers in CloudStack + false + 4.11.0 + + + name + List CA service provider by name + false + string + + + + + description + the description of the CA service provider + string + + + name + the CA service provider name + string + + + false + + + deleteVpnCustomerGateway + Delete site to site vpn customer gateway + true + + + id + id of customer gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + acquirePodIpAddress + Allocates IP addresses in respective Pod of a Zone + false + + + zoneid + the ID of the zone + true + string + + + podid + Pod ID + false + string + + + + + id + the ID of the pod the IP address + long + + + cidr + CIDR of the Pod + string + + + gateway + Gateway for Pod + string + + + hostmac + MAC address of the pod the IP + long + + + ipaddress + Allocated IP address + string + + + nicid + the ID of the nic + long + + + podid + the ID of the pod the IP address belongs to + long + + + false + + + enableOutOfBandManagementForCluster + Enables out-of-band management for a cluster + true + 4.9.0 + + + clusterid + the ID of the cluster + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listPortForwardingRules + Lists all port forwarding rules for an IP address. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the port forwarding services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list port forwarding rules for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateTemplatePermissions + Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them. + false + + + id + the template ID + true + uuid + + + accounts + a comma delimited list of accounts within caller's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + isextractable + true if the template/iso is extractable, false other wise. Can be set only by root admin + false + boolean + + + isfeatured + true for featured template/iso, false otherwise + false + boolean + + + ispublic + true for public template/iso, false for private templates/isos + false + boolean + + + op + permission operator (add, remove, reset) + false + string + + + projectids + a comma delimited list of projects. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + resetPasswordForVirtualMachine + Resets the password for virtual machine. The virtual machine must be in a "Stopped" state and the template must already support this feature for this command to take effect. [async] + true + + + id + The ID of the virtual machine + true + uuid + + + password + The new password of the virtual machine. If null, a random password will be generated for the VM. + false + 4.19.0 + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listBrocadeVcsDevices + Lists Brocade VCS Switches + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + vcsdeviceid + Brocade VCS switch ID + false + uuid + + + + + brocadedevicename + device name + string + + + hostname + the principal switch Ip address + string + + + physicalnetworkid + the physical Network to which this Brocade VCS belongs to + string + + + provider + name of the provider + string + + + vcsdeviceid + device id of the Brocade Vcs + string + + + false + + + linkDomainToLdap + link an existing cloudstack domain to group or OU in ldap + false + 4.6.0 + + + accounttype + Type of the account to auto import. Specify 0 for user and 2 for domain admin + true + integer + + + domainid + The id of the domain which has to be linked to LDAP. + true + uuid + + + type + type of the ldap name. GROUP or OU + true + string + + + admin + domain admin username in LDAP + false + string + + + ldapdomain + name of the group or OU in LDAP + false + string + + + name + name of the group or OU in LDAP + false + string + + + + + accountid + Domain Admin accountId that is created + string + + + accounttype + Type of the account to auto import + int + + + domainid + id of the Domain which is linked to LDAP + string + + + ldapdomain + name of the group or OU in LDAP which is linked to the domain + string + + + name + name of the group or OU in LDAP which is linked to the domain + string + + + type + type of the name in LDAP which is linked to the domain + string + + + false + + + setupUserTwoFactorAuthentication + Setup the 2FA for the user. + false + 4.18.0 + + + enable + Enabled by default, provide false to disable 2FA + false + boolean + + + provider + two factor authentication code + false + string + + + userid + optional: the id of the user for which 2FA has to be disabled + false + uuid + + + + + id + the user ID + string + + + accountid + the account ID of the user + string + + + secretcode + secret code that needs to be registered with authenticator + string + + + username + the user name + string + + + false + + + listVpnCustomerGateways + Lists site to site vpn customer gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + id of the customer gateway + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + deleteKubernetesCluster + Deletes a Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + cleanup + Destroy attached instances of the ExternalManaged Cluster. Default: false + false + 4.19.0 + boolean + + + expunge + Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false + false + 4.19.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAndSwitchSamlAccount + Lists and switches to other SAML accounts owned by the SAML user + false + + + domainid + Domain uuid + false + uuid + + + userid + User uuid + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createGlobalLoadBalancerRule + Creates a global load balancer rule + true + + + gslbdomainname + domain name for the GSLB service. + true + string + + + gslbservicetype + GSLB service type (tcp, udp, http) + true + string + + + name + name of the load balancer rule + true + string + + + regionid + region where the global load balancer is going to be created. + true + integer + + + account + the account associated with the global load balancer. Must be used with the domainId parameter. + false + string + + + description + the description of the load balancer rule + false + string + + + domainid + the domain ID associated with the load balancer + false + uuid + + + gslblbmethod + load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin' + false + string + + + gslbstickysessionmethodname + session sticky method (sourceip) if not specified defaults to sourceip + false + string + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + deleteNetscalerLoadBalancer + delete a netscaler load balancer device + true + + + lbdeviceid + netscaler load balancer device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTags + List resource tag(s) + false + 4.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + customer + list by customer name + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + key + list by key + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + list by resource id + false + string + + + resourcetype + list by resource type + false + string + + + value + list by value + false + string + + + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + false + + + listAffectedVmsForStorageScopeChange + List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster. + false + 4.19.1 + + + clusterid + the Id of the cluster the scope of the storage pool is being changed to + true + uuid + + + storageid + the Id of the storage pool on which change scope operation is being done + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the VM + string + + + clusterid + the cluster ID for the VM + string + + + clustername + the cluster name for the VM + string + + + hostid + the host ID for the VM + string + + + hostname + the hostname for the VM + string + + + name + the name of the VM + string + + + type + the type of VM + string + + + false + + + createVirtualRouterElement + Create a virtual router element. + true + + + nspid + the network service provider ID of the virtual router element + true + uuid + + + providertype + The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + createVPC + Creates a VPC + true + + + cidr + the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR + true + string + + + name + the name of the VPC + true + string + + + vpcofferingid + the ID of the VPC offering + true + uuid + + + zoneid + the ID of the availability zone + true + uuid + + + account + the account associated with the VPC. Must be used with the domainId parameter. + false + string + + + displaytext + The display text of the VPC, defaults to its 'name'. + false + string + + + dns1 + the first IPv4 DNS for the VPC + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the VPC + false + 4.18.0 + string + + + domainid + the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain. + false + uuid + + + fordisplay + an optional field, whether to the display the vpc to the end user or not + false + 4.4 + boolean + + + ip6dns1 + the first IPv6 DNS for the VPC + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + false + 4.18.0 + string + + + networkdomain + VPC network domain. All networks inside the VPC will belong to this domain + false + string + + + projectid + create VPC for the project + false + uuid + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. +If an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented, + false + 4.19 + string + + + start + If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default. + false + 4.3 + boolean + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + removeResourceDetail + Removes detail for the Resource. + true + + + resourceid + Delete details for resource id + true + string + + + resourcetype + Delete detail by resource type + true + string + + + key + Delete details matching key/value pairs + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listOsTypes + Lists all supported OS types for this cloud. + false + + + description + list os by description + false + 3.0.1 + string + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.18.1 + boolean + + + id + list by Os type Id + false + uuid + + + keyword + List by keyword + false + string + + + oscategoryid + list by Os Category id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + fordisplay + is the guest OS visible for the users + boolean + + + isuserdefined + is the guest OS user defined + boolean + + + name + the name of the OS type + string + + + oscategoryid + the ID of the OS category + string + + + oscategoryname + the name of the OS category + string + + + false + + + removeGuestOs + Removes a Guest OS from listing. + true + 4.4.0 + + + id + ID of the guest OS + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + detachIso + Detaches any ISO file (if any) currently attached to a virtual machine. + true + + + virtualmachineid + The ID of the virtual machine + true + uuid + + + forced + If true, ejects the ISO before detaching on VMware. Default: false + false + 4.15.1 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deletePaloAltoFirewall + delete a Palo Alto firewall device + true + + + fwdeviceid + Palo Alto firewall device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deletePod + Deletes a Pod. + false + + + id + the ID of the Pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricProviders + Lists Tungsten-Fabric providers + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + false + uuid + + + + + name + Tungsten-Fabric provider name + string + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + tungstengateway + Tungsten-Fabric provider gateway + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + string + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + string + + + tungstenproviderport + Tungsten-Fabric provider port + string + + + tungstenprovideruuid + Tungsten-Fabric provider uuid + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listDeploymentPlanners + Lists all DeploymentPlanners available. + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + Deployment Planner name + string + + + false + + + prepareHostForMaintenance + Prepares a host for maintenance. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteCluster + Deletes a cluster. + false + + + id + the cluster ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getVolumeiScsiName + Get Volume's iSCSI Name + false + + + volumeid + CloudStack Volume UUID + true + string + + + + + volumeiScsiName + Volume iSCSI Name + string + + + false + + + removeRegion + Removes specified region + false + + + id + ID of the region to delete + true + integer + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateAutoScaleVmGroup + Updates an existing autoscale vm group. + true + + + id + the ID of the autoscale group + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the group to the end user or not + false + 4.4 + boolean + + + interval + the frequency in which the performance counters to be collected + false + integer + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + false + integer + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + false + integer + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + scaledownpolicyids + list of scaledown autoscale policies + false + list + list + + + scaleuppolicyids + list of scaleup autoscale policies + false + list + list + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + deleteSnapshot + Deletes a snapshot of a disk volume. + true + + + id + The ID of the snapshot + true + uuid + + + zoneid + The ID of the zone for the snapshot + false + 4.19.0 + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVirtualMachines + List the virtual machines owned by the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + clusterid + the cluster ID + false + 4.16.0 + uuid + + + details + comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hostid + the host ID + false + uuid + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. + false + 4.19.0 + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + storageid + the storage ID where vm's volumes belong to + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listDiskOfferings + Lists all available disk offerings. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + encrypt + listed offerings support disk encryption + false + 4.18 + boolean + + + id + ID of the disk offering + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the disk offering + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings. + false + 4.19 + string + + + storageid + The ID of the storage pool, tags of the storage pool are used to filter the offerings + false + 4.17 + uuid + + + storagetype + the storage type of the service offering. Values are local and shared. + false + 4.19 + string + + + volumeid + The ID of the volume, tags of the volume are used to filter the offerings + false + 4.17 + uuid + + + zoneid + id of zone disk offering is associated with + false + 4.13 + uuid + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + state + state of the disk offering + string + + + storagetype + the storage type for this disk offering + string + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + deleteCiscoAsa1000vResource + Deletes a Cisco ASA 1000v appliance + false + + + resourceid + Cisco ASA 1000v resource ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + upgradeKubernetesCluster + Upgrades a running CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + kubernetesversionid + the ID of the Kubernetes version for upgrade + true + uuid + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + createCondition + Creates a condition for VM auto scaling + true + + + counterid + ID of the Counter. + true + uuid + + + relationaloperator + Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE. + true + string + + + threshold + Value for which the Counter will be evaluated with the Operator selected. + true + long + + + account + the account of the condition. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID of the account. + false + uuid + + + projectid + an optional project for condition + false + uuid + + + + + id + the id of the Condition + string + + + account + the owner of the Condition. + string + + + counter + Details of the Counter. + counterresponse + + + counterid + the Id of the Counter. + string + + + countername + the Name of the Counter. + string + + + domain + the domain name of the owner. + string + + + domainid + the domain id of the Condition owner + string + + + domainpath + path of the domain to which the Condition owner belongs + 4.19.2.0 + string + + + project + the project name of the Condition + string + + + projectid + the project id of the Condition. + string + + + relationaloperator + Relational Operator to be used with threshold. + string + + + threshold + Threshold Value for the counter. + long + + + zoneid + zone id of counter + string + + + false + + + listProjects + Lists projects and provides detailed information for listed projects + false + 3.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + details + comma separated list of project details requested, value can be a list of [ all, resource, min] + false + list + list + + + displaytext + list projects by display text + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list projects by project ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list projects by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for projects + false + boolean + + + state + list projects by state + false + string + + + tags + List projects by tags (key/value pairs) + false + map + map + + + username + List projects by username + false + string + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createAccount + Creates an account + false + + + email + email + true + string + + + firstname + firstname + true + string + + + lastname + lastname + true + string + + + password + Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Unique username. + true + string + + + account + Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accountid + Account UUID, required for adding account from external provisioning system + false + string + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + Creates the user under the specified domain. + false + uuid + + + networkdomain + Network domain for the account's networks + false + string + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + revertToVMSnapshot + Revert VM from a vmsnapshot. + true + 4.2.0 + + + vmsnapshotid + The ID of the vm snapshot + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeGuestOsMapping + Removes a Guest OS Mapping. + true + 4.4.0 + + + id + ID of the guest OS mapping + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricServiceGroup + create Tungsten-Fabric service group + true + + + endport + Tungsten-Fabric service group end port + true + integer + + + name + Tungsten-Fabric service group name + true + string + + + protocol + Tungsten-Fabric service group protocol + true + string + + + startport + Tungsten-Fabric service group start port + true + integer + + + zoneid + the ID of zone + true + uuid + + + + + endport + Tungsten-Fabric service group end port + int + + + name + Tungsten-Fabric service group name + string + + + protocol + Tungsten-Fabric service group protocol + string + + + startport + Tungsten-Fabric service group start port + int + + + uuid + Tungsten-Fabric service group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + registerIso + Registers an existing ISO into the CloudStack Cloud. + false + + + name + the name of the ISO + true + string + + + url + the URL to where the ISO is currently being hosted + true + string + + + zoneid + the ID of the zone you wish to register the ISO to. + true + uuid + + + account + an optional account name. Must be used with domainId. + false + string + + + bootable + true if this ISO is bootable. If not passed explicitly its assumed to be true + false + boolean + + + checksum + the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + directdownload + true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + displaytext + the display text of the ISO, defaults to the 'name' + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + imagestoreuuid + Image store UUID + false + string + + + isdynamicallyscalable + true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory + false + boolean + + + isextractable + true if the ISO or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if you want this ISO to be featured + false + boolean + + + ispublic + true if you want to register the ISO to be publicly available to all users, false otherwise. + false + boolean + + + ostypeid + the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed + false + uuid + + + passwordenabled + true if password reset feature is supported; default is false + false + boolean + + + projectid + Register ISO for the project + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listCiscoAsa1000vResources + Lists Cisco ASA 1000v appliances + false + + + hostname + Hostname or ip address of the Cisco ASA 1000v appliance. + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + resourceid + Cisco ASA 1000v resource ID + false + uuid + + + + false + + + deletePortableIpRange + deletes a range of portable public IP's associated with a region + true + + + id + Id of the portable ip range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + upgradeRouterTemplate + Upgrades router to use newer template + false + + + account + upgrades all routers owned by the specified account + false + string + + + clusterid + upgrades all routers within the specified cluster + false + uuid + + + domainid + upgrades all routers owned by the specified domain + false + uuid + + + id + upgrades router with the specified Id + false + uuid + + + podid + upgrades all routers within the specified pod + false + uuid + + + zoneid + upgrades all routers within the specified zone + false + uuid + + + + + jobid + the UUID of the latest async job acting on this object + string + + + jobstatus + the current status of the latest async job acting on this object + integer + + + false + + + listVlanIpRanges + Lists all VLAN IP ranges. + false + + + account + the account with which the VLAN IP range is associated. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain. + false + uuid + + + forvirtualnetwork + true if VLAN is of Virtual type, false if Direct + false + boolean + + + id + the ID of the VLAN IP range + false + uuid + + + keyword + List by keyword + false + string + + + networkid + network id of the VLAN IP range + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + physical network id of the VLAN IP range + false + uuid + + + podid + the Pod ID of the VLAN IP range + false + uuid + + + projectid + project who will own the VLAN + false + uuid + + + vlan + the ID or VID of the VLAN. Default is an "untagged" VLAN. + false + string + + + zoneid + the Zone ID of the VLAN IP range + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + updateZone + Updates a Zone. + false + + + id + the ID of the Zone + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + details + the details for the Zone + false + map + map + + + dhcpprovider + the dhcp Provider for the Zone + false + string + + + dns1 + the first DNS for the Zone + false + string + + + dns2 + the second DNS for the Zone + false + string + + + dnssearchorder + the dns search order list + false + list + list + + + domain + Network domain name for the networks in the zone; empty string will update domain with NULL value + false + string + + + guestcidraddress + the guest CIDR address for the Zone + false + string + + + internaldns1 + the first internal DNS for the Zone + false + string + + + internaldns2 + the second internal DNS for the Zone + false + string + + + ip6dns1 + the first DNS for IPv6 network in the Zone + false + string + + + ip6dns2 + the second DNS for IPv6 network in the Zone + false + string + + + ispublic + updates a private zone to public if set, but not vice-versa + false + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + false + boolean + + + name + the name of the Zone + false + string + + + sortkey + sort key of the zone, integer + false + integer + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + cancelHostMaintenance + Cancels host maintenance. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + extractVolume + Extracts volume + true + + + id + the ID of the volume + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + zoneid + the ID of the zone where the volume is located + true + uuid + + + url + the url to which the volume would be extracted + false + string + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + listProjectAccounts + Lists project's accounts + false + 3.0.0 + + + projectid + ID of the project + true + uuid + + + account + list accounts of the project by account name + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectroleid + list accounts of the project by project role id + false + uuid + + + role + list accounts of the project by role + false + string + + + userid + list invitation by user ID + false + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateAutoScalePolicy + Updates an existing autoscale policy. + true + + + id + the ID of the autoscale policy + true + uuid + + + conditionids + the list of IDs of the conditions that are being evaluated on every interval + false + list + list + + + duration + the duration in which the conditions have to be true before action is taken + false + integer + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + quiettime + the cool down period in which the policy should not be evaluated after the action has been taken + false + integer + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + domainpath + path of the domain to which the autoscale policy belongs + 4.19.2.0 + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + createDiskOffering + Creates a disk offering. + false + + + name + name of the disk offering + true + string + + + bytesreadrate + bytes read rate of the disk offering + false + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + long + + + byteswriterate + bytes write rate of the disk offering + false + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + long + + + cachemode + the cache mode to use for this disk offering. none, writeback or writethrough + false + 4.14 + string + + + customized + whether disk offering size is custom or not + false + boolean + + + customizediops + whether disk offering iops is custom or not + false + boolean + + + details + details to specify disk offering parameters + false + map + 4.16 + map + + + disksize + size of the disk offering in GB (1GB = 1,073,741,824 bytes) + false + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + false + 4.17 + boolean + + + displayoffering + an optional field, whether to display the offering to the end user or not. + false + boolean + + + displaytext + An alternate display text of the disk offering, defaults to 'name'. + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + encrypt + Volumes using this offering should be encrypted + false + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + false + integer + + + iopsreadrate + io requests read rate of the disk offering + false + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + long + + + iopswriterate + io requests write rate of the disk offering + false + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + long + + + maxiops + max iops of the disk offering + false + long + + + miniops + min iops of the disk offering + false + long + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + false + string + + + storagepolicy + Name of the storage policy defined at vCenter, this is applicable only for VMware + false + 4.15 + uuid + + + storagetype + the storage type of the disk offering. Values are local and shared. + false + string + + + tags + tags for the disk offering + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + state + state of the disk offering + string + + + storagetype + the storage type for this disk offering + string + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + listLBHealthCheckPolicies + Lists load balancer health check policies. + false + 4.2.0 + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the health check policy + false + 4.4 + uuid + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the load balancer rule + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + migrateVirtualMachineWithVolume + Attempts Migration of a VM with its volumes to a different host + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host for a running instance, if hostId is not specified. false by default + false + 4.19.0 + boolean + + + hostid + Destination Host ID to migrate VM to. + false + uuid + + + migrateto + Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=<uuid>&migrateto[volume-index].pool=<uuid>Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume=<uuid> indicates the UUID of the volume that you want to migrate, and pool=<uuid> indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc> + false + map + map + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateUser + Updates a user account + false + + + id + User uuid + true + uuid + + + currentpassword + Current password that was being used by the user. You must inform the current password when updating the password. + false + string + + + email + email + false + string + + + firstname + first name + false + string + + + lastname + last name + false + string + + + mandate2fa + Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA + false + 4.18.0.0 + boolean + + + password + Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port + false + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userapikey + The API key for the user. Must be specified with userSecretKey + false + string + + + username + Unique username + false + string + + + usersecretkey + The secret key for the user. Must be specified with userApiKey + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + removeCertFromLoadBalancer + Removes a certificate from a load balancer rule + true + + + lbruleid + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addHost + Adds a new host. + false + + + hypervisor + hypervisor type of the host + true + string + + + podid + the Pod ID for the host + true + uuid + + + url + the host URL + true + string + + + zoneid + the Zone ID for the host + true + uuid + + + allocationstate + Allocation state of this Host for allocation of new resources + false + string + + + clusterid + the cluster ID for the host + false + uuid + + + clustername + the cluster name for the host + false + string + + + hosttags + list of tags to be added to the host + false + list + list + + + password + the password for the host; required to be passed for hypervisors other than VMWare + false + string + + + username + the username for the host; required to be passed for hypervisors other than VMWare + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + attachVolume + Attaches a disk volume to a virtual machine. + true + + + id + the ID of the disk volume + true + uuid + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + deviceid + The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.<br>When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:<ul><li>0 maps to /dev/xvda;</li><li>1 maps to /dev/xvdb;</li><li>2 maps /dev/xvdc and so on.</li></ul>Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure. + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listLoadBalancers + Lists internal load balancers + false + 4.2.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the load balancer + false + string + + + networkid + the network ID of the load balancer + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + scheme + the scheme of the load balancer. Supported value is internal in the current release + false + string + + + sourceipaddress + the source IP address of the load balancer + false + string + + + sourceipaddressnetworkid + the network ID of the source IP address + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + domainpath + path of the domain to which the Load Balancer belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateProject + Updates a project + true + 3.0.0 + + + id + id of the project to be modified + true + uuid + + + account + new Admin account for the project + false + string + + + displaytext + display text of the project + false + string + + + name + name of the project + false + 4.19.0 + string + + + roletype + Account level role to be assigned to the user/account : Admin/Regular + false + string + + + swapowner + when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true + false + boolean + + + userid + ID of the user to be promoted/demoted + false + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteLBStickinessPolicy + Deletes a load balancer stickiness policy. + true + 3.0.0 + + + id + the ID of the LB stickiness policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + registerUserKeys + This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user + false + + + id + User id + true + uuid + + + + + apikey + the api key of the registered user + string + + + secretkey + the secret key of the registered user + string + + + false + + + listVpnConnections + Lists site to site vpn connection gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + id of the vpn connection + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + id of vpc + false + uuid + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + removeTungstenFabricPolicy + remove Tungsten-Fabric policy + true + + + networkuuid + the uuid of Tungsten-Fabric network + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateCloudToUseObjectStore + Migrate current NFS secondary storages to use object store. + false + 4.3.0 + + + provider + the image store provider name + true + string + + + details + the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + name + the name for the image store + false + string + + + url + the URL for the image store + false + string + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + addTungstenFabricNetworkGatewayToLogicalRouter + add Tungsten-Fabric network gateway to logical router + true + + + logicalrouteruuid + Tungsten-Fabric logical router uuid + true + string + + + networkuuid + Tungsten-Fabric network uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listTungstenFabricNic + list Tungsten-Fabric nic + false + + + keyword + List by keyword + false + string + + + nicuuid + the uuid of Tungsten-Fabric nic + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric nic name + string + + + uuid + Tungsten-Fabric nic uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + applyTungstenFabricPolicy + apply Tungsten-Fabric policy + true + + + majorsequence + the major sequence of Tungsten-Fabric policy + true + integer + + + minorsequence + the minor sequence of Tungsten-Fabric policy + true + integer + + + networkuuid + the uuid of network + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listVmwareDcs + Retrieves VMware DC(s) associated with a zone. + false + + + zoneid + Id of the CloudStack zone. + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + listZones + Lists zones + false + + + available + true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false. + false + boolean + + + domainid + the ID of the domain associated with the zone + false + uuid + + + id + the ID of the zone + false + uuid + + + ids + the IDs of the zones, mutually exclusive with id + false + list + 4.19.0 + list + + + keyword + List by keyword + false + string + + + name + the name of the zone + false + string + + + networktype + the network type of the zone that the virtual machine belongs to + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the zones + false + boolean + + + showicon + flag to display the resource image for the zones + false + boolean + + + tags + List zones by resource tags (key/value pairs) + false + map + 4.3 + map + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + removeQuarantinedIp + Removes a public IP address from quarantine. Only IPs in active quarantine can be removed. + false + 4.19 + + + removalreason + The reason for removing the public IP address from quarantine prematurely. + true + string + + + id + The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine. + false + uuid + + + ipaddress + The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine. + false + string + + + + + id + ID of the quarantine process. + string + + + created + When the quarantine was created. + date + + + enddate + End date for the quarantine. + date + + + ipaddress + The public IP address in quarantine. + string + + + previousownerid + Account ID of the previous public IP address owner. + string + + + previousownername + Account name of the previous public IP address owner. + string + + + removalreason + The reason for removing the IP from quarantine prematurely. + string + + + removed + When the quarantine was removed. + date + + + removeraccountid + ID of the account that removed the IP from quarantine. + string + + + false + + + deleteBackupSchedule + Deletes the backup schedule of a VM + false + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBackupProviderOfferings + Lists external backup offerings of the provider + false + 4.14.0 + + + zoneid + The zone ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + releasePublicIpRange + Releases a Public IP range back to the system pool + false + + + id + the id of the Public IP range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricPublicNetwork + create Tungsten-Fabric public network + false + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetscalerLoadBalancerNetworks + lists network that are using a netscaler load balancer device + false + + + lbdeviceid + netscaler load balancer device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listNetworkIsolationMethods + Lists supported methods of network isolation + false + 4.2.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + Network isolation method name + string + + + false + + + listHostHAResources + Lists host HA resources + false + 4.11 + + + hostid + List by host ID + false + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + listTungstenFabricFirewallPolicy + list Tungsten-Fabric firewall policy + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + firewallrule + list Tungsten-Fabric firewall rule + list + + + name + Tungsten-Fabric firewall policy name + string + + + uuid + Tungsten-Fabric firewall policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + importBackupOffering + Imports a backup offering using a backup provider + true + 4.14.0 + + + allowuserdrivenbackups + Whether users are allowed to create adhoc backups and backup schedules + true + boolean + + + description + the description of the backup offering + true + string + + + externalid + The backup offering ID (from backup provider side) + true + string + + + name + the name of the backup offering + true + string + + + zoneid + The zone ID + true + uuid + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + deleteDomain + Deletes a specified domain + true + + + id + ID of domain to delete + true + uuid + + + cleanup + true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateVolume + Migrate volume + true + 3.0.0 + + + storageid + destination storage pool ID to migrate the volume to + true + uuid + + + volumeid + the ID of the volume + true + uuid + + + livemigrate + if the volume should be live migrated when it is attached to a running vm + false + boolean + + + newdiskofferingid + The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to. + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTungstenFabricApplicationPolicySet + create Tungsten-Fabric application policy set + true + + + name + Tungsten-Fabric application policy set name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + firewallpolicy + list Tungsten-Fabric firewall policy + list + + + name + Tungsten-Fabric policy name + string + + + tag + list Tungsten-Fabric tag + list + + + uuid + Tungsten-Fabric application policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listEvents + A command to list events. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + archived + true to list archived events otherwise false + false + 4.19.0 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + duration + the duration of the event + false + integer + + + enddate + the end date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss") + false + date + + + entrytime + the time the event was entered + false + integer + + + id + the ID of the event + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + level + the event level (INFO, WARN, ERROR) + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + the ID of the resource associated with the event + false + 4.17.0 + string + + + resourcetype + the type of the resource associated with the event + false + 4.17.0 + string + + + startdate + the start date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss") + false + date + + + startid + the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event + false + uuid + + + type + the event type (see event types) + false + string + + + + + id + the ID of the event + string + + + account + the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group) + string + + + archived + whether the event has been archived or not + boolean + + + created + the date the event was created + date + + + description + a brief description of the event + string + + + domain + the name of the account's domain + string + + + domainid + the id of the account's domain + string + + + domainpath + path of the Domain the account's domain belongs to + 4.19.2.0 + string + + + level + the event level (INFO, WARN, ERROR) + string + + + parentid + whether the event is parented + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + resourceid + the id of the resource + 4.17.0 + string + + + resourcename + the name of the resource + 4.17.0 + string + + + resourcetype + the type of the resource + 4.17.0 + string + + + state + the state of the event + state + + + type + the type of the event (see event types) + string + + + username + the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine) + string + + + false + + + listHostHAProviders + Lists HA providers + false + 4.11 + + + hypervisor + Hypervisor type of the resource + true + string + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + createTags + Creates resource tag(s) + true + 4.0.0 + + + resourceids + list of resources to create the tags for + true + list + list + + + resourcetype + type of the resource + true + string + + + tags + Map of tags (key/value pairs) + true + map + map + + + customer + identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createInternalLoadBalancerElement + Create an Internal Load Balancer element. + true + 4.2.0 + + + nspid + the network service provider ID of the internal load balancer element + true + uuid + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + resetApiLimit + Reset api count + false + + + account + the ID of the account whose limit to be reset + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVlanIpRange + Deletes a VLAN IP range. + false + + + id + the id of the VLAN IP range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + generateAlert + Generates an alert + true + 4.3 + + + description + Alert description + true + string + + + name + Name of the alert + true + string + + + type + Type of the alert + true + short + + + podid + Pod id for which alert is generated + false + uuid + + + zoneid + Zone id for which alert is generated + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + ldapConfig + (Deprecated, use addLdapConfiguration) Configure the LDAP context for this site. + false + 3.0.0 + + + binddn + Specify the distinguished name of a user with the search permission on the directory. + false + string + + + bindpass + Enter the password. + false + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + false + string + + + listall + If true return current LDAP configuration + false + boolean + + + port + Specify the LDAP port if required, default is 389. + false + integer + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain. + false + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com. + false + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL. + false + boolean + + + truststore + Enter the path to trust certificates store. + false + string + + + truststorepass + Enter the password for trust store. + false + string + + + + + binddn + Specify the distinguished name of a user with the search permission on the directory + string + + + bindpass + DN password + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + string + + + port + Specify the LDAP port if required, default is 389 + string + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL + string + + + true + + + listVsphereStoragePolicies + List vSphere storage policies + false + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the Storage Policy + string + + + description + the description of the Storage Policy + string + + + name + the name of the Storage Policy + string + + + policyid + the identifier of the Storage Policy in vSphere DataCenter + string + + + zoneid + the ID of the Zone + string + + + false + + + deletePortForwardingRule + Deletes a port forwarding rule + true + + + id + the ID of the port forwarding rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateVPC + moves a vpc to another physical network + true + 4.11.0 + + + vpcid + the ID of the vpc + true + uuid + + + vpcofferingid + vpc offering ID + true + uuid + + + resume + true if previous network migration cmd failed + false + boolean + + + tiernetworkofferings + network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2 + false + map + map + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteGlobalLoadBalancerRule + Deletes a global load balancer rule. + true + + + id + the ID of the global load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateAnnotationVisibility + update an annotation visibility. + false + 4.16 + + + id + the id of the annotation + true + string + + + adminsonly + the annotation is visible for admins only + true + boolean + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + updateConfiguration + Updates a configuration. + false + + + name + the name of the configuration + true + string + + + accountid + the ID of the Account to update the parameter value for corresponding account + false + uuid + + + clusterid + the ID of the Cluster to update the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to update the parameter value for corresponding domain + false + uuid + + + imagestoreuuid + the ID of the Image Store to update the parameter value for corresponding image store + false + uuid + + + storageid + the ID of the Storage pool to update the parameter value for corresponding storage pool + false + uuid + + + value + the value of the configuration + false + string + + + zoneid + the ID of the Zone to update the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + configureHAForHost + Configures HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + provider + HA provider + true + string + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + listVolumesUsageHistory + Lists volume stats + false + 4.18.0 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the volume. + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the volume + string + + + name + the name of the volume + string + + + stats + the list of VM stats + list + + + false + + + dedicatePublicIpRange + Dedicates a Public IP range to an account + false + + + id + the id of the VLAN IP range + true + uuid + + + domainid + domain ID of the account owning a VLAN + true + uuid + + + account + account who will own the VLAN + false + string + + + projectid + project who will own the VLAN + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + deleteBucket + Deletes an empty Bucket. + false + 4.19.0 + + + id + The ID of the Bucket + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createProjectRolePermission + Adds API permissions to a project role + false + 4.15.0 + + + permission + The rule permission, allow or deny. Default: deny. + true + string + + + projectid + ID of project where project role permission is to be created + true + uuid + + + projectroleid + ID of the project role + true + uuid + + + rule + The API name or wildcard rule such as list* + true + string + + + description + The description of the role permission + false + string + + + + + id + the ID of the project role permission + string + + + projectid + the ID of the project + string + + + projectroleid + the ID of the project role to which the role permission belongs + string + + + projectrolename + the name of the project role to which the role permission belongs + string + + + false + + + createConsoleEndpoint + Create a console endpoint to connect to a VM console + false + 4.18.0 + + + virtualmachineid + ID of the VM + true + uuid + + + token + (optional) extra security token, valid when the extra validation is enabled + false + string + + + + + details + details in case of an error + string + + + success + true if the console endpoint is generated properly + boolean + + + url + the console url + string + + + websocket + the console websocket options + consoleendpointwebsocketresponse + + + false + + + updateProjectRolePermission + Updates a project role permission and/or order + false + 4.15.0 + + + projectid + ID of project where project role permission is to be updated + true + uuid + + + projectroleid + ID of the project role + true + uuid + + + permission + Rule permission, can be: allow or deny + false + string + + + projectrolepermissionid + Project Role permission rule id + false + uuid + + + ruleorder + The parent role permission uuid, use 0 to move this rule at the top of the list + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addUserToProject + Adds user to a project + true + 4.14 + + + projectid + ID of the project to add the user to + true + uuid + + + username + Name of the user to be added to the project + true + string + + + email + email ID of user to which invitation to the project is going to be sent + false + string + + + projectroleid + ID of the project role + false + uuid + + + roletype + Project role type to be assigned to the user - Admin/Regular + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteTungstenFabricFirewallPolicy + delete Tungsten-Fabric firewall policy + true + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableHAForCluster + Disables HA cluster-wide + true + 4.11 + + + clusterid + ID of the cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + recoverVirtualMachine + Recovers a virtual machine. + false + + + id + The ID of the virtual machine + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + resetNetworkPermissions + Resets network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateTungstenFabricLBHealthMonitor + update Tungsten-Fabric loadbalancer health monitor + true + + + interval + loadbalancer health monitor interval + true + integer + + + lbruleid + the ID of lb rule + true + uuid + + + retry + loadbalancer health monitor retry + true + integer + + + timeout + loadbalancer health monitor timeout + true + integer + + + type + loadbalancer health monitor type + true + string + + + expectedcode + loadbalancer health monitor expected code + false + string + + + httpmethodtype + loadbalancer health monitor http method + false + string + + + urlpath + loadbalancer health monitor url path + false + string + + + + + id + the health monitor ID + long + + + expectedcode + the health monitor expected code + string + + + httpmethod + the health monitor http method + string + + + interval + the health monitor interval + int + + + lbruleid + the LB rule ID + string + + + retry + the health monitor retry + int + + + timeout + the health monitor timeout + int + + + type + the health monitor type + string + + + urlpath + the health monitor url path + string + + + uuid + the health monitor UUID + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + releaseDedicatedHost + Release the dedication for host + true + + + hostid + the ID of the host + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateProjectInvitation + Accepts or declines project invitation + true + 3.0.0 + + + projectid + id of the project to join + true + uuid + + + accept + if true, accept the invitation, decline if false. True by default + false + boolean + + + account + account that is joining the project + false + string + + + token + list invitations for specified account; this parameter has to be specified with domainId + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + revertSnapshot + This is supposed to revert a volume snapshot. This command is only supported with KVM so far + true + + + id + The ID of the snapshot + true + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateCondition + Updates a condition for VM auto scaling + true + 4.18.0 + + + id + the ID of the condition. + true + uuid + + + relationaloperator + Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE. + true + string + + + threshold + Value for which the Counter will be evaluated with the Operator selected. + true + long + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listRegions + Lists Regions + false + + + id + List Region by region ID. + false + integer + + + keyword + List by keyword + false + string + + + name + List Region by region name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + configureInternalLoadBalancerElement + Configures an Internal Load Balancer element. + true + 4.2.0 + + + id + the ID of the internal lb provider + true + uuid + + + enabled + Enables/Disables the Internal Load Balancer element + true + boolean + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + migrateSystemVm + Attempts Migration of a system virtual machine to the host specified. + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default + false + 4.16.0 + boolean + + + hostid + destination Host ID to migrate VM to + false + uuid + + + storageid + Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume + false + 4.16.0 + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + listCounters + List the counters for VM auto scaling + false + + + id + ID of the Counter. + false + uuid + + + keyword + List by keyword + false + string + + + name + Name of the counter. + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + Network provider of the counter. + false + 4.18.0 + string + + + source + Source of the counter. + false + string + + + + + id + the id of the Counter + string + + + name + Name of the counter. + string + + + provider + Provider of the counter. + string + + + source + Source of the counter. + string + + + value + Value in case of snmp or other specific counters. + string + + + zoneid + zone id of counter + string + + + false + + + removeTungstenFabricTag + remove Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + networkuuid + the uuid of networks + false + list + list + + + nicuuid + the uuid of nics + false + list + list + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + vmuuid + the uuid of vms + false + list + list + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listVirtualRouterElements + Lists all available virtual router elements. + false + + + enabled + list network offerings by enabled state + false + boolean + + + id + list virtual router elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list virtual router elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + linkAccountToLdap + link a cloudstack account to a group or OU in ldap + false + 4.11.0 + + + account + name of the account, it will be created if it does not exist + true + string + + + domainid + The id of the domain that is to contain the linked account. + true + uuid + + + ldapdomain + name of the group or OU in LDAP + true + string + + + accounttype + Type of the account to auto import. Specify 0 for user and 2 for domain admin + false + integer + + + admin + domain admin username in LDAP + false + string + + + roleid + Creates the account under the specified role. + false + 4.19.1 + uuid + + + type + type of the ldap name. GROUP or OU, defaults to GROUP + false + string + + + + + accountid + Domain Admin accountId that is created + string + + + accounttype + Type of the account to auto import + int + + + domainid + id of the Domain which is linked to LDAP + string + + + ldapdomain + name of the group or OU in LDAP which is linked to the domain + string + + + name + name of the group or OU in LDAP which is linked to the domain + string + + + type + type of the name in LDAP which is linked to the domain + string + + + false + + + disableOutOfBandManagementForHost + Disables out-of-band management for a host + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + cancelHostAsDegraded + Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'. + true + 4.16.0.0 + + + id + host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createSecurityGroup + Creates a security group + false + + + name + name of the security group + true + string + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + description + the description of the security group + false + string + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + Create security group for project + false + uuid + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listNetworkPermissions + List network visibility and all accounts that have permissions to view this network. + false + 4.17.0 + + + networkid + Lists network permission by network ID + true + uuid + + + + + account + the account the network is available for + string + + + accountid + the ID of account the network is available for + string + + + domain + the name of the domain to which the network belongs + string + + + domainid + the ID of the domain to which the network belongs + string + + + networkid + the network ID + string + + + project + the project the network is available for + string + + + projectid + the ID of project the network is available for + string + + + false + + + removeVirtualMachineFromBackupOffering + Removes a VM from any existing backup offering + true + 4.14.0 + + + virtualmachineid + ID of the virtual machine + true + uuid + + + forced + Whether to force remove VM from the backup offering that may also delete VM backups. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVpnGateways + Lists site 2 site vpn gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + id of the vpn gateway + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + id of vpc + false + uuid + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + moveUser + Moves a user to another account in the same domain. + false + 4.11 + + + id + id of the user to be moved. + true + uuid + + + account + Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id. + false + string + + + accountid + Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name. + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + releaseHostReservation + Releases host reservation. + true + + + id + the host ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVpnConnection + Create site to site vpn connection + true + + + s2scustomergatewayid + id of the customer gateway + true + uuid + + + s2svpngatewayid + id of the vpn gateway + true + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + passive + connection is passive or not + false + boolean + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + listBrocadeVcsDeviceNetworks + lists network that are using a brocade vcs switch + false + + + vcsdeviceid + brocade vcs switch ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + dedicateHost + Dedicates a host. + true + + + domainid + the ID of the containing domain + true + uuid + + + hostid + the ID of the host to update + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the host + string + + + affinitygroupid + the Dedication Affinity Group ID of the host + string + + + domainid + the domain ID of the host + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + false + + + addGloboDnsHost + Adds the GloboDNS external host + true + 4.5.0 + + + password + Password for GloboDNS + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + GloboDNS url + true + string + + + username + Username for GloboDNS + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + logout + Logs out the user + false + + + + description + Response description + string + + + false + + + importRole + Imports a role based on provided map of rule permissions + false + 4.15.0 + + + name + Creates a role with this unique name + true + string + + + rules + Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing + true + map + map + + + description + The description of the role + false + string + + + forced + Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false. + false + boolean + + + ispublic + Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public). + false + boolean + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + quotaEmailTemplateUpdate + Updates existing email templates for quota alerts + false + 4.7.0 + + + templatebody + The quota email template body, max: 500k characters + true + string + + + templatesubject + The quota email template subject, max: 77 characters + true + string + + + templatetype + Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY + true + string + + + locale + The locale of the email text + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkServiceProviders + Lists network serviceproviders for a given physical network. + false + 3.0.0 + + + keyword + List by keyword + false + string + + + name + list providers by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + state + list providers by state + false + string + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + deleteTungstenFabricTagType + delete Tungsten-Fabric tag type + true + + + tagtypeuuid + the ID of Tungsten-Fabric tag type + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetscalerControlCenter + Delete Netscaler Control Center + false + + + id + Netscaler Control Center ID + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteObjectStoragePool + Deletes an Object Storage Pool + false + 4.19.0 + + + id + The Object Storage ID. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVolume + Deletes a detached disk volume. + false + + + id + The ID of the disk volume + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateSecondaryStorageSelector + Updates an existing secondary storage selector. + false + 4.19.0 + + + id + The unique identifier of the secondary storage selector. + true + uuid + + + heuristicrule + The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID. + true + string + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + enableUser + Enables a user account + false + + + id + Enables user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + quotaTariffCreate + Creates a quota tariff for a resource. + false + 4.18.0.0 + + + name + Quota tariff's name + true + string + + + usagetype + Integer value for the usage type of the resource. + true + integer + + + value + The quota tariff value of the resource as per the default unit. + true + double + + + activationrule + Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. + false + string + + + description + Quota tariff's description. + false + string + + + enddate + The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2009-06-03. + false + date + + + startdate + The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. Inform null to use the current date. + false + date + + + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + uuid + uuid + string + + + false + + + suspendProject + Suspends a project + true + 3.0.0 + + + id + id of the project to be suspended + true + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getApiLimit + Get API limit count for the caller + false + + + + account + the account name of the api remaining count + string + + + accountid + the account uuid of the api remaining count + string + + + apiAllowed + currently allowed number of apis + int + + + apiIssued + number of api already issued + int + + + expireAfter + seconds left to reset counters + long + + + false + + + deleteStorageNetworkIpRange + Deletes a storage network IP Range. + true + 3.0.0 + + + id + the uuid of the storage network ip range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addVmwareDc + Adds a VMware datacenter to specified zone + false + + + name + Name of VMware datacenter to be added to specified zone. + true + string + + + vcenter + The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + true + string + + + zoneid + The Zone ID. + true + uuid + + + password + The password for specified username. + false + string + + + username + The Username required to connect to resource. + false + string + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + updateIpv6FirewallRule + Updates Ipv6 firewall rule with specified ID + true + + + id + the ID of the ipv6 firewall rule + true + uuid + + + cidrlist + the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + endport + the ending port of Ipv6 firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the Ipv6 firewall rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + protocol + the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + false + string + + + startport + the starting port of Ipv6 firewall rule + false + integer + + + traffictype + the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateIsoPermissions + Updates ISO permissions + false + + + id + the template ID + true + uuid + + + accounts + a comma delimited list of accounts within caller's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + isextractable + true if the template/iso is extractable, false other wise. Can be set only by root admin + false + boolean + + + isfeatured + true for featured template/iso, false otherwise + false + boolean + + + ispublic + true for public template/iso, false for private templates/isos + false + boolean + + + op + permission operator (add, remove, reset) + false + string + + + projectids + a comma delimited list of projects. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVPCOffering + Deletes VPC offering + true + + + id + the ID of the VPC offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkACL + Deletes a network ACL + true + + + id + the ID of the network ACL + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricTag + create Tungsten-Fabric tag + true + + + tagtype + Tungsten-Fabric tag type + true + string + + + tagvalue + Tungsten-Fabric tag value + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + addOpenDaylightController + Adds an OpenDyalight controler + true + + + password + Credential to access the OpenDaylight API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + Api URL of the OpenDaylight Controller. + true + string + + + username + Username to access the OpenDaylight API + true + string + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + createZone + Creates a Zone. + false + + + dns1 + the first DNS for the Zone + true + string + + + internaldns1 + the first internal DNS for the Zone + true + string + + + name + the name of the Zone + true + string + + + networktype + network type of the zone, can be Basic or Advanced + true + string + + + allocationstate + Allocation state of this Zone for allocation of new resources + false + string + + + dns2 + the second DNS for the Zone + false + string + + + domain + Network domain name for the networks in the zone + false + string + + + domainid + the ID of the containing domain, null for public zones + false + uuid + + + guestcidraddress + the guest CIDR address for the Zone + false + string + + + internaldns2 + the second internal DNS for the Zone + false + string + + + ip6dns1 + the first DNS for IPv6 network in the Zone + false + string + + + ip6dns2 + the second DNS for IPv6 network in the Zone + false + string + + + isedge + true if the zone is an edge zone, false otherwise + false + 4.18.0 + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + false + boolean + + + securitygroupenabled + true if network is security group enabled, false otherwise + false + boolean + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listDomainChildren + Lists all children domains belonging to a specified domain + false + + + id + list children domain by parent domain ID. + false + uuid + + + isrecursive + to return the entire tree, use the value "true". To return the first level children, use the value "false". + false + boolean + + + keyword + List by keyword + false + string + + + listall + 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 + false + boolean + + + name + list children domains by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for domains + false + boolean + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + getVMPassword + Returns an encrypted password for the VM + false + + + id + The ID of the virtual machine + true + uuid + + + + + encryptedpassword + The base64 encoded encrypted password of the VM + string + + + false + + + assignToGlobalLoadBalancerRule + Assign load balancer rule or list of load balancer rules to a global load balancer rules. + true + + + id + the ID of the global load balancer rule + true + uuid + + + loadbalancerrulelist + the list load balancer rules that will be assigned to global load balancer rule + true + list + list + + + gslblbruleweightsmap + Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10' + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addImageStoreS3 + Adds S3 Image Store + false + 4.7.0 + + + accesskey + S3 access key + true + string + + + bucket + Name of the storage bucket + true + string + + + endpoint + S3 endpoint + true + string + + + secretkey + S3 secret key + true + string + + + connectiontimeout + Connection timeout (milliseconds) + false + integer + + + connectionttl + Connection TTL (milliseconds) + false + integer + + + maxerrorretry + Maximum number of times to retry on error + false + integer + + + s3signer + Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType + false + string + + + sockettimeout + Socket timeout (milliseconds) + false + integer + + + usehttps + Use HTTPS instead of HTTP + false + boolean + + + usetcpkeepalive + Whether TCP keep-alive is used + false + boolean + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + uploadTemplateDirectDownloadCertificate + Upload a certificate for HTTPS direct template download on KVM hosts + false + 4.11.0 + + + certificate + SSL certificate + true + string + + + hypervisor + Hypervisor type + true + string + + + name + Name for the uploaded certificate + true + string + + + zoneid + Zone to upload certificate + true + uuid + + + hostid + (optional) the host ID to upload certificate + false + uuid + + + + + id + the direct download certificate id + string + + + alias + the direct download certificate alias + string + + + hostsmap + the hosts where the certificate is uploaded to + list + + + hypervisor + the hypervisor of the hosts where the certificate is uploaded + string + + + issuer + the direct download certificate issuer + string + + + serialnum + the direct download certificate serial num + string + + + subject + the direct download certificate subject + string + + + validity + the direct download certificate issuer + string + + + version + the direct download certificate version + string + + + zoneid + the zone id where the certificate is uploaded + string + + + zonename + the zone name where the certificate is uploaded + string + + + false + + + importUnmanagedInstance + Import unmanaged virtual machine from a given cluster. + true + 4.14.0 + + + clusterid + the cluster ID + true + uuid + + + name + the name of the instance as it is known to the hypervisor + true + string + + + serviceofferingid + the service offering for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping using keys disk and diskOffering + false + map + map + + + details + used to specify the custom parameters. + false + map + map + + + displayname + the display name of the instance + false + string + + + domainid + import instance to the domain specified + false + uuid + + + forced + VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated + false + boolean + + + hostname + the host name of the instance + false + string + + + migrateallowed + vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool + false + boolean + + + nicipaddresslist + VM nic to ip address mapping using keys nic, ip4Address + false + map + map + + + nicnetworklist + VM nic to network id mapping using keys nic and network + false + map + map + + + projectid + import instance for the project + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createPhysicalNetwork + Creates a physical network + true + 3.0.0 + + + name + the name of the physical network + true + string + + + zoneid + the Zone ID for the physical network + true + uuid + + + broadcastdomainrange + the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic + false + string + + + domainid + domain ID of the account owning a physical network + false + uuid + + + isolationmethods + the isolation method for the physical network[VLAN/L3/GRE] + false + list + list + + + networkspeed + the speed for the physical network[1G/10G] + false + string + + + tags + Tag the physical network + false + list + list + + + vlan + the VLAN for the physical network + false + string + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + listAutoScaleVmGroups + Lists autoscale vm groups. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the autoscale vm group + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the loadbalancer + false + uuid + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + page + false + integer + + + pagesize + false + integer + + + policyid + the ID of the policy + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vmprofileid + the ID of the profile + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + updatePod + Updates a Pod. + false + + + id + the ID of the Pod + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + endip + the ending IP address for the Pod + false + string + + + gateway + the gateway for the Pod + false + string + + + name + the name of the Pod + false + string + + + netmask + the netmask of the Pod + false + string + + + startip + the starting IP address for the Pod + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + attachIso + Attaches an ISO to a virtual machine. + true + + + id + the ID of the ISO file + true + uuid + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + forced + If true, ejects existing ISO before attaching on VMware. Default: false + false + 4.15.1 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + ldapRemove + (Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site. + false + 3.0.1 + + + + binddn + Specify the distinguished name of a user with the search permission on the directory + string + + + bindpass + DN password + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + string + + + port + Specify the LDAP port if required, default is 389 + string + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL + string + + + true + + + createUser + Creates a user for an account that already exists + false + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + true + string + + + email + email + true + string + + + firstname + firstname + true + string + + + lastname + lastname + true + string + + + password + Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Unique username. + true + string + + + domainid + Creates the user under the specified domain. Has to be accompanied with the account parameter + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + createVpnGateway + Creates site to site vpn local gateway + true + + + vpcid + public ip address id of the vpn gateway + true + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + addResourceDetail + Adds detail for the Resource. + true + + + details + Map of (key/value pairs) + true + map + map + + + resourceid + resource id to create the details for + true + string + + + resourcetype + type of the resource + true + string + + + fordisplay + pass false if you want this detail to be disabled for the regular user. True by default + false + 4.4 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVpnUsers + Lists vpn users + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + The uuid of the Vpn user + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + username + the username of the vpn user. + false + string + + + + + id + the vpn userID + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'. + string + + + username + the username of the vpn user + string + + + false + + + deleteIpForwardingRule + Deletes an IP forwarding rule + true + + + id + the ID of the forwarding rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + registerUserData + Register a new userdata. + false + 4.18 + + + name + Name of the userdata + true + string + + + userdata + Base64 encoded userdata content. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + true + string + + + account + an optional account for the userdata. Must be used with domainId. + false + string + + + domainid + an optional domainId for the userdata. If the account parameter is used, domainId must also be used. + false + uuid + + + params + comma separated list of variables declared in userdata content + false + string + + + projectid + an optional project for the userdata + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addRegion + Adds a Region + false + + + id + Id of the Region + true + integer + + + endpoint + Region service endpoint + true + string + + + name + Name of the region + true + string + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + generateUsageRecords + Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed + false + + + enddate + End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + true + date + + + startdate + Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + true + date + + + domainid + List events for the specified domain. + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateRolePermission + Updates a role permission order + false + 4.9.0 + + + roleid + ID of the role + true + uuid + + + permission + Rule permission, can be: allow or deny + false + 4.11 + string + + + ruleid + Role permission rule id + false + 4.11 + uuid + + + ruleorder + The parent role permission uuid, use 0 to move this rule at the top of the list + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAccounts + Lists accounts and provides detailed account information for listed accounts + false + + + accounttype + list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user). + false + integer + + + details + comma separated list of account details requested, value can be a list of [ all, resource, min] + false + list + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list account by account ID + false + uuid + + + iscleanuprequired + list accounts by cleanuprequired attribute (values are true or false) + false + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list account by account name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for accounts + false + boolean + + + state + list accounts by state. Valid states are enabled, disabled, and locked. + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + destroyRouter + Destroys a router. + true + + + id + the ID of the router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listImageStores + Lists image stores. + false + 4.2.0 + + + id + the ID of the storage pool + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the image store + false + string + + + page + false + integer + + + pagesize + false + integer + + + protocol + the image store protocol + false + string + + + provider + the image store provider + false + string + + + readonly + read-only status of the image store + false + 4.15.0 + boolean + + + zoneid + the Zone ID for the image store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + deleteAccount + Deletes a account, and all users associated with this account + true + + + id + Account id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableOutOfBandManagementForCluster + Disables out-of-band management for a cluster + true + 4.9.0 + + + clusterid + the ID of the cluster + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + deleteSslCert + Delete a certificate to CloudStack + false + + + id + Id of SSL certificate + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + activateProject + Activates a project + true + 3.0.0 + + + id + id of the project to be modified + true + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteAlerts + Delete one or more alerts. + false + + + enddate + end date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the alerts + false + list + list + + + startdate + start date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + delete by alert type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createAutoScaleVmProfile + Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature. + true + + + serviceofferingid + the service offering of the auto deployed virtual machine + true + uuid + + + templateid + the template of the auto deployed virtual machine + true + uuid + + + zoneid + availability zone for the auto deployed virtual machine + true + uuid + + + account + account that will own the autoscale VM profile + false + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + false + uuid + + + counterparam + counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161 + false + map + map + + + domainid + domain ID of the account owning a autoscale VM profile + false + uuid + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is expunged + false + integer + + + fordisplay + an optional field, whether to the display the profile to the end user or not + false + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. +Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 . +Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". + false + map + map + + + projectid + an optional project for the autoscale VM profile + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + 4.18.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18.1 + map + + + userdataid + the ID of the Userdata + false + 4.18.1 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + domainpath + path of the domain to which the vm profile belongs + 4.19.2.0 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base64 encoded VM user data + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.1 + string + + + userdataid + the id of userdata used for the VM + 4.18.1 + string + + + userdataname + the name of userdata used for the VM + 4.18.1 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.1 + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + registerOauthProvider + Register the OAuth2 provider in CloudStack + false + 4.19.0 + + + clientid + Client ID pre-registered in the specific OAuth provider + true + string + + + description + Description of the OAuth Provider + true + string + + + provider + Name of the provider from the list of OAuth providers supported in CloudStack + true + string + + + redirecturi + Redirect URI pre-registered in the specific OAuth provider + true + string + + + secretkey + Secret Key pre-registered in the specific OAuth provider + true + string + + + details + Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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 + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listLBStickinessPolicies + Lists load balancer stickiness policies. + false + 3.0.0 + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer stickiness policy + false + uuid + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the load balancer rule + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + addUcsManager + Adds a Ucs manager + false + + + password + the password of UCS + true + string + + + url + the name of UCS url + true + string + + + username + the username of UCS + true + string + + + zoneid + the Zone id for the ucs manager + true + uuid + + + name + the name of UCS manager + false + string + + + + + id + the ID of the ucs manager + string + + + name + the name of ucs manager + string + + + url + the url of ucs manager + string + + + zoneid + the zone ID of ucs manager + string + + + false + + + deleteVnfTemplate + Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected. + true + 4.19.0 + + + id + the ID of the template + true + uuid + + + forced + Force delete a template. + false + 4.9+ + boolean + + + zoneid + the ID of zone of the template + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetscalerLoadBalancers + lists netscaler load balancer devices + false + + + keyword + List by keyword + false + string + + + lbdeviceid + netscaler load balancer device ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + createInstanceGroup + Creates a vm group + false + + + name + the name of the instance group + true + string + + + account + the account of the instance group. The account parameter must be used with the domainId parameter. + false + string + + + domainid + the domain ID of account owning the instance group + false + uuid + + + projectid + The project of the instance group + false + uuid + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + domainpath + path of the Domain the instance group belongs to + 4.19.2.0 + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + createLoadBalancer + Creates an internal load balancer + true + 4.2.0 + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + true + string + + + instanceport + the TCP port of the virtual machine where the network traffic will be load balanced to + true + integer + + + name + name of the load balancer + true + string + + + networkid + The guest network the load balancer will be created for + true + uuid + + + scheme + the load balancer scheme. Supported value in this release is Internal + true + string + + + sourceipaddressnetworkid + the network id of the source ip address + true + uuid + + + sourceport + the source port the network traffic will be load balanced from + true + integer + + + description + the description of the load balancer + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + sourceipaddress + the source IP address the network traffic will be load balanced from + false + string + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + domainpath + path of the domain to which the Load Balancer belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateBackupSchedule + Updates a user-defined VM backup schedule + false + 4.14.0 + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + schedule + custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + date + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + addPaloAltoFirewall + Adds a Palo Alto firewall device + true + + + networkdevicetype + supports only PaloAltoFirewall + true + string + + + password + Credentials to reach Palo Alto firewall device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the Palo Alto appliance. + true + string + + + username + Credentials to reach Palo Alto firewall device + true + string + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + createPrivateGateway + Creates a private gateway + true + 4.17.0 + + + gateway + the gateway of the Private gateway + true + string + + + ipaddress + the IP address of the Private gateaway + true + string + + + netmask + the netmask of the Private gateway + true + string + + + vpcid + the VPC network belongs to + true + uuid + + + aclid + the ID of the network ACL + false + uuid + + + associatednetworkid + The isolated network this private gateway is associated to. + false + 4.17.0 + uuid + + + bypassvlanoverlapcheck + when true bypasses VLAN id/range overlap check during private gateway creation + false + boolean + + + networkofferingid + the uuid of the network offering to use for the private gateways network connection + false + uuid + + + physicalnetworkid + the Physical Network ID the network belongs to + false + uuid + + + sourcenatsupported + source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported + false + boolean + + + vlan + the network implementation uri for the private gateway + false + string + + + + + id + the id of the private gateway + string + + + account + the account associated with the private gateway + string + + + aclid + ACL Id set for private gateway + string + + + aclname + ACL name set for private gateway + string + + + domain + the domain associated with the private gateway + string + + + domainid + the ID of the domain associated with the private gateway + string + + + domainpath + path of the domain to which the private gateway belongs + 4.19.2.0 + string + + + gateway + the gateway + string + + + ipaddress + the private gateway's ip address + string + + + netmask + the private gateway's netmask + string + + + physicalnetworkid + the physical network id + string + + + project + the project name of the private gateway + string + + + projectid + the project id of the private gateway + string + + + sourcenatsupported + Source Nat enable status + boolean + + + state + State of the gateway, can be Creating, Ready, Deleting + string + + + vlan + the network implementation uri for the private gateway + string + + + vpcid + VPC id the private gateway belongs to + string + + + vpcname + VPC name the private gateway belongs to + 4.13.2 + string + + + zoneid + zone id of the private gateway + string + + + zonename + the name of the zone the private gateway belongs to + string + + + false + + + updateOauthProvider + Updates the registered OAuth provider details + false + 4.19.0 + + + id + id of the OAuth provider to be updated + true + uuid + + + clientid + Client ID pre-registered in the specific OAuth provider + false + string + + + description + Description of the OAuth Provider + false + string + + + enabled + OAuth provider will be enabled or disabled based on this value + false + boolean + + + redirecturi + Redirect URI pre-registered in the specific OAuth provider + false + string + + + secretkey + Secret Key pre-registered in the specific OAuth provider + false + string + + + + + id + ID of the provider + string + + + clientid + Client ID registered in the OAuth provider + string + + + description + Description of the provider registered + string + + + enabled + Whether the OAuth provider is enabled or not + boolean + + + name + Name of the provider + string + + + provider + Name of the provider + string + + + redirecturi + Redirect URI registered in the OAuth provider + string + + + secretkey + Secret key registered in the OAuth provider + string + + + false + + + deleteFirewallRule + Deletes a firewall rule + true + + + id + the ID of the firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + uploadSslCert + Upload a certificate to CloudStack + false + + + certificate + SSL certificate + true + string + + + name + Name for the uploaded certificate + true + string + + + privatekey + Private key + true + string + + + account + account that will own the SSL certificate + false + string + + + certchain + Certificate chain of trust + false + string + + + domainid + domain ID of the account owning the SSL certificate + false + uuid + + + enabledrevocationcheck + Enables revocation checking for certificates + false + 4.15 + boolean + + + password + Password for the private key + false + string + + + projectid + an optional project for the SSL certificate + false + uuid + + + + + id + SSL certificate ID + string + + + account + account for the certificate + string + + + certchain + certificate chain + string + + + certificate + certificate + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + fingerprint + certificate fingerprint + string + + + loadbalancerrulelist + List of loabalancers this certificate is bound to + list + + + name + name + string + + + project + the project name of the certificate + string + + + projectid + the project id of the certificate + string + + + false + + + createVpnCustomerGateway + Creates site to site vpn customer gateway + true + + + cidrlist + guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,). + true + string + + + esppolicy + ESP policy of the customer gateway + true + string + + + gateway + public ip address id of the customer gateway + true + string + + + ikepolicy + IKE policy of the customer gateway + true + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes. + true + string + + + account + the account associated with the gateway. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain. + false + uuid + + + dpd + If DPD is enabled for VPN connection + false + boolean + + + esplifetime + Lifetime of phase 2 VPN connection to the customer gateway, in seconds + false + long + + + forceencap + Force Encapsulation for NAT traversal + false + boolean + + + ikelifetime + Lifetime of phase 1 VPN connection to the customer gateway, in seconds + false + long + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike + false + 4.15.1 + string + + + name + name of this customer gateway + false + string + + + projectid + create site-to-site VPN customer gateway for the project + false + 4.6 + uuid + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + false + 4.15.1 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + addBaremetalHost + add a baremetal host + false + + + hypervisor + hypervisor type of the host + true + string + + + podid + the Pod ID for the host + true + uuid + + + url + the host URL + true + string + + + zoneid + the Zone ID for the host + true + uuid + + + allocationstate + Allocation state of this Host for allocation of new resources + false + string + + + clusterid + the cluster ID for the host + false + uuid + + + clustername + the cluster name for the host + false + string + + + hosttags + list of tags to be added to the host + false + list + list + + + ipaddress + ip address intentionally allocated to this host after provisioning + false + string + + + password + the password for the host; required to be passed for hypervisors other than VMWare + false + string + + + username + the username for the host; required to be passed for hypervisors other than VMWare + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeAnnotation + remove an annotation. + false + 4.11 + + + id + the id of the annotation + true + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + deleteRolePermission + Deletes a role permission + false + 4.9.0 + + + id + ID of the role permission + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateVMSchedule + Update VM Schedule. + false + 4.19.0 + + + id + ID of VM schedule + true + uuid + + + description + Name of the schedule + false + string + + + enabled + Enable VM schedule + false + boolean + + + enddate + end date after which the schedule becomes inactiveUse format "yyyy-MM-dd hh:mm:ss") + false + date + + + schedule + Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month' + false + string + + + startdate + start date from which the schedule becomes activeUse format "yyyy-MM-dd hh:mm:ss") + false + date + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + false + string + + + + + id + the ID of VM schedule + string + + + action + Action + action + + + created + Date when the schedule was created + date + + + description + Description of VM schedule + string + + + enabled + VM schedule is enabled + boolean + + + enddate + Date after which the schedule becomes inactive + date + + + schedule + Cron formatted VM schedule + string + + + startdate + Date from which the schedule is active + date + + + timezone + Timezone of the schedule + string + + + virtualmachineid + ID of virtual machine + string + + + false + + + listConfigurationGroups + Lists all configuration groups (primarily used for UI). + false + 4.18.0 + + + group + lists configuration group by group name + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + description + the description of the configuration group + string + + + name + the name of the configuration group + string + + + precedence + the precedence of the configuration group + long + + + subgroup(*) + the subgroups of the configuration group + + + name + the name of the configuration subgroup + string + + + precedence + the precedence of the configuration subgroup + long + + + list + + + false + + + releasePodIpAddress + Releases a Pod IP back to the Pod + false + + + id + UUID of the Pod IP + true + long + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateRemoteAccessVpn + Updates remote access vpn + true + 4.4 + + + id + id of the remote access vpn + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + destroyVirtualMachine + Destroys a virtual machine. Once destroyed, only the administrator can recover it. + true + + + id + The ID of the virtual machine + true + uuid + + + expunge + If true is passed, the vm is expunged immediately. False by default. + false + 4.2.1 + boolean + + + volumeids + Comma separated list of UUIDs for volumes that will be deleted + false + list + 4.12.0 + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + assignVirtualMachineToBackupOffering + Assigns a VM to a backup offering + true + 4.14.0 + + + backupofferingid + ID of the backup offering + true + uuid + + + virtualmachineid + ID of the virtual machine + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + startVirtualMachine + Starts a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + bootintosetup + Boot into hardware setup menu or not + false + 4.15.0.0 + boolean + + + clusterid + destination Cluster ID to deploy the VM to - parameter available for root admin only + false + uuid + + + considerlasthost + True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process. + false + 4.18.0 + boolean + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + 3.0.1 + uuid + + + podid + destination Pod ID to deploy the VM to - parameter available for root admin only + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listResourceIcon + Lists the resource icon for the specified resource(s) + false + 4.16.0.0 + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + base64image + base64 representation of resource icon + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + resourceobjecttype + + + false + + + createPod + Creates a new Pod. + false + + + name + the name of the Pod + true + string + + + zoneid + the Zone ID in which the Pod will be created + true + uuid + + + allocationstate + Allocation state of this Pod for allocation of new resources + false + string + + + endip + the ending IP address for the Pod + false + string + + + gateway + the gateway for the Pod + false + string + + + netmask + the netmask for the Pod + false + string + + + startip + the starting IP address for the Pod + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + removeRawUsageRecords + Safely removes raw records from cloud_usage table + false + 4.6.0 + + + interval + 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 + true + integer + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + provisionCertificate + Issues and propagates client certificate on a connected host/agent using configured CA plugin + true + 4.11.0 + + + hostid + The host/agent uuid to which the certificate has to be provisioned (issued and propagated) + true + uuid + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + reconnect + Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVirtualMachinesMetrics + Lists VM metrics + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + clusterid + the cluster ID + false + uuid + + + details + comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hostid + the host ID + false + uuid + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. + false + 4.19.0 + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + storageid + the storage ID where vm's volumes belong to + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + cputotal + the total cpu capacity in Ghz + string + + + diskiopstotal + the total disk iops + long + + + diskread + disk read in MiB + string + + + diskwrite + disk write in MiB + string + + + memorytotal + the total memory capacity in GiB + string + + + networkread + network read in MiB + string + + + networkwrite + network write in MiB + string + + + false + + + deleteStoragePool + Deletes a storage pool. + false + + + id + Storage pool id + true + uuid + + + forced + Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal) + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listHosts + Lists hosts. + false + + + clusterid + lists hosts existing in particular cluster + false + uuid + + + details + comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats] + false + list + list + + + hahost + if true, list only hosts dedicated to HA + false + boolean + + + hypervisor + hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator + false + string + + + id + the id of the host + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the host + false + string + + + outofbandmanagementenabled + list hosts for which out-of-band management is enabled + false + boolean + + + outofbandmanagementpowerstate + list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown] + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID for the host + false + uuid + + + resourcestate + 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] + false + string + + + state + the state of the host + false + string + + + type + the host type + false + string + + + virtualmachineid + lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM + false + uuid + + + zoneid + the Zone ID for the host + false + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteGuestNetworkIpv6Prefix + Deletes an existing guest network IPv6 prefix. + true + 4.17.0.0 + + + id + Id of the guest network IPv6 prefix + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateStoragePool + Updates a storage pool. + false + 3.0.0 + + + id + the Id of the storage pool + true + uuid + + + capacitybytes + bytes CloudStack can provision from this storage pool + false + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + false + long + + + details + the details for the storage pool + false + map + 4.19.0 + map + + + enabled + false to disable the pool for allocation of new volumes, true to enable it back. + false + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + false + boolean + + + name + Change the name of the storage pool + false + 4.15 + string + + + tags + comma-separated list of tags for the storage pool + false + list + list + + + url + the URL of the storage pool + false + 4.19.0 + string + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTungstenFabricTag + Lists Tungsten-Fabric tags + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + keyword + List by keyword + false + string + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + nicuuid + the uuid of Tungsten-Fabric nic + false + string + + + page + false + integer + + + pagesize + false + integer + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + taguuid + the uuid of Tungsten-Fabric tag + false + string + + + vmuuid + the uuid of Tungsten-Fabric vm + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + importLdapUsers + Import LDAP users + false + 4.3.0 + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + 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 + false + uuid + + + group + Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported. + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + moveDomain + Moves a domain and its children to a new parent domain. + false + 4.19.0.0 + + + domainid + The ID of the domain to be moved. + true + uuid + + + parentdomainid + The ID of the new parent domain of the domain to be moved. + true + uuid + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + listNetworks + Lists all available networks. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + acltype + list networks by ACL (access control list) type. Supported values are account and domain + false + string + + + associatednetworkid + List networks by associated networks. Only available if create a Shared network. + false + 4.17.0 + uuid + + + canusefordeploy + list networks available for VM deployment + false + boolean + + + displaynetwork + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvpc + the network belongs to VPC + false + boolean + + + id + list networks by ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issystem + true if network is system, false otherwise + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkfilter + possible values are "account", "domain", "accountdomain","shared", and "all". Default value is "all".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared). + false + 4.17.0 + string + + + networkofferingid + list networks by network offering ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + list networks by physical network id + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + restartrequired + list networks by restartRequired + false + boolean + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + showicon + flag to display the resource icon for networks + false + boolean + + + specifyipranges + true if need to list only networks which support specifying IP ranges + false + boolean + + + supportedservices + list networks supporting certain services + false + list + list + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + type of the traffic + false + string + + + type + the type of the network. Supported values are: isolated, l2, shared and all + false + string + + + vlan + the ID or VID of the network + false + 4.17.0 + string + + + vpcid + List networks by VPC + false + uuid + + + zoneid + the zone ID of the network + false + uuid + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + releaseIpAddress + Releases an IP address from the account. + false + 4.17 + + + id + the ID of the public IP address to release + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updatePodManagementNetworkIpRange + Updates a management network IP range. Only allowed when no IPs are allocated. + true + 4.16.0.0 + + + currentendip + The current ending IP address. + true + string + + + currentstartip + The current starting IP address. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + newendip + The new ending IP address. + false + string + + + newstartip + The new starting IP address. + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateFirewallRule + Updates firewall rule + true + 4.4 + + + id + the ID of the firewall rule + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + quotaIsEnabled + Return true if the plugin is enabled + false + 4.7.0 + + + + isenabled + is quota service enabled + boolean + + + false + + + quotaEmailTemplateList + Lists all quota email templates + false + 4.7.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + templatetype + List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY + false + string + + + + + last_updated + Last date/time when template was updated + date + + + locale + The quota email template locale + string + + + templatebody + The quota email template content + string + + + templatesubject + The quota email template subject + string + + + templatetype + Template type + string + + + false + + + deleteOauthProvider + Deletes the registered OAuth provider + false + 4.19.0 + + + id + id of the OAuth provider to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listHypervisors + List hypervisors + false + + + zoneid + the zone id for listing hypervisors. + false + uuid + + + + + name + Hypervisor name + string + + + false + + + listHostsMetrics + Lists hosts metrics + false + 4.9.3 + + + clusterid + lists hosts existing in particular cluster + false + uuid + + + details + comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats] + false + list + list + + + hahost + if true, list only hosts dedicated to HA + false + boolean + + + hypervisor + hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator + false + string + + + id + the id of the host + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the host + false + string + + + outofbandmanagementenabled + list hosts for which out-of-band management is enabled + false + boolean + + + outofbandmanagementpowerstate + list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown] + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID for the host + false + uuid + + + resourcestate + 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] + false + string + + + state + the state of the host + false + string + + + type + the host type + false + string + + + virtualmachineid + lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM + false + uuid + + + zoneid + the Zone ID for the host + false + uuid + + + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedghz + the total cpu allocated in Ghz + string + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpuloadaverage + the average cpu load the last minute + double + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotalghz + the total cpu capacity in Ghz + string + + + cpuusedghz + the total cpu used in Ghz + string + + + instances + instances on the host + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedgb + the total memory allocated in GiB + string + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotalgb + the total memory capacity in GiB + string + + + memoryusedgb + the total memory used in GiB + string + + + networkread + network read in GiB + string + + + networkwrite + network write in GiB + string + + + powerstate + out-of-band management power state + powerstate + + + systeminstances + system vm instances on the host + string + + + false + + + releaseDedicatedPod + Release the dedication for the pod + true + + + podid + the ID of the Pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAffinityGroups + Lists affinity groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list the affinity group by the ID provided + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + lists affinity groups by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + type + lists affinity groups by type + false + string + + + virtualmachineid + lists affinity groups by virtual machine ID + false + uuid + + + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + false + + + cancelShutdown + Cancels a triggered shutdown + false + 4.19.0 + + + managementserverid + the uuid of the management server + true + uuid + + + + + managementserverid + The id of the management server + long + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + registerSSHKeyPair + Register a public key in a keypair under a certain name + false + + + name + Name of the keypair + true + string + + + publickey + Public key material of the keypair + true + string + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the ssh key. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the ssh key + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the keypair + string + + + domain + the domain name of the keypair owner + string + + + domainid + the domain id of the keypair owner + string + + + fingerprint + Fingerprint of the public key + string + + + name + Name of the keypair + string + + + project + the project name of the keypair owner + string + + + projectid + the project id of the keypair owner + string + + + false + + + reserveIpAddress + Reserve a public IP to an account. + false + 4.17 + + + id + the ID of the public IP address to reserve + true + uuid + + + account + the account to reserve with this IP address + false + string + + + domainid + the ID of the domain to reserve with this IP address + false + uuid + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + boolean + + + projectid + the ID of the project to reserve with this IP address + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteEvents + Delete one or more events. + false + + + enddate + end date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the events + false + list + list + + + startdate + start date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + delete by event type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteIso + Deletes an ISO file. + true + + + id + the ID of the ISO file + true + uuid + + + zoneid + the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVPCOfferings + Lists VPC offerings + false + + + displaytext + list VPC offerings by display text + false + string + + + domainid + list VPC offerings available for VPC creation in specific domain + false + 4.18 + uuid + + + id + list VPC offerings by id + false + uuid + + + isdefault + true if need to list only default VPC offerings. Default value is false + false + boolean + + + keyword + List by keyword + false + string + + + name + list VPC offerings by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + state + list VPC offerings by state + false + string + + + supportedservices + list VPC offerings supporting certain services + false + list + list + + + zoneid + id of zone VPC offering is associated with + false + 4.13 + uuid + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + getSolidFireVolumeSize + Get the SF volume size including Hypervisor Snapshot Reserve + false + + + volumeid + Volume UUID + true + string + + + + + solidFireVolumeSize + SolidFire Volume Size Including Hypervisor Snapshot Reserve + long + + + false + + + uploadVolume + Uploads a data disk. + true + + + format + the format for the volume. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume + true + string + + + url + the URL of where the volume is hosted. Possible URL include http:// and https:// + true + string + + + zoneid + the ID of the zone the volume is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + checksum + the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + diskofferingid + the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown. + false + uuid + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain. + false + uuid + + + imagestoreuuid + Image store uuid + false + string + + + projectid + Upload volume for the project + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + configureOutOfBandManagement + Configures a host's out-of-band management interface + false + 4.9.0 + + + address + the host management interface IP address + true + string + + + driver + the host management interface driver, for example: ipmitool + true + string + + + hostid + the ID of the host + true + uuid + + + password + the host management interface password + true + string + + + port + the host management interface port + true + string + + + username + the host management interface user + true + string + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listStorageTags + Lists storage tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the storage tag + string + + + name + the name of the storage tag + string + + + poolid + the pool ID of the storage tag + long + + + false + + + deleteVMSchedule + Delete VM Schedule. + false + 4.19.0 + + + virtualmachineid + ID of VM + true + uuid + + + id + ID of VM schedule + false + uuid + + + ids + IDs of VM schedule + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTemplatePermissions + List template visibility and all accounts that have permissions to view this template. + false + + + id + the template ID + true + uuid + + + + + id + the template ID + string + + + account + the list of accounts the template is available for + list + + + domainid + the ID of the domain to which the template belongs + string + + + ispublic + true if this template is a public template, false otherwise + boolean + + + projectids + the list of projects the template is available for + list + + + false + + + listAnnotations + Lists annotations. + false + 4.11 + + + annotationfilter + possible values are "self" and "all". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access + false + 4.16.0 + string + + + entityid + the id of the entity for which to show annotations + false + string + + + entitytype + the entity type + false + string + + + id + the id of the annotation + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + userid + optional: the id of the user of the annotation + false + 4.16.0 + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + addSwift + Adds Swift. + false + 3.0.0 + + + url + the URL for swift + true + string + + + account + the account for swift + false + string + + + key + key for the user for swift + false + string + + + username + the username for swift + false + string + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + listSnapshotPolicies + Lists snapshot policies. + false + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the snapshot policy + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + volumeid + the ID of the disk volume + false + uuid + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + zone + The list of zones in which snapshot backup is scheduled + 4.19.0 + set + + + false + + + updateVpnCustomerGateway + Update site to site vpn customer gateway + true + + + id + id of customer gateway + true + uuid + + + cidrlist + guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,). + true + string + + + esppolicy + ESP policy of the customer gateway + true + string + + + gateway + public ip address id of the customer gateway + true + string + + + ikepolicy + IKE policy of the customer gateway + true + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes. + true + string + + + account + the account associated with the gateway. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain. + false + uuid + + + dpd + If DPD is enabled for VPN connection + false + boolean + + + esplifetime + Lifetime of phase 2 VPN connection to the customer gateway, in seconds + false + long + + + forceencap + Force encapsulation for Nat Traversal + false + boolean + + + ikelifetime + Lifetime of phase 1 VPN connection to the customer gateway, in seconds + false + long + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike + false + 4.15.1 + string + + + name + name of this customer gateway + false + string + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + false + 4.15.1 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + applyTungstenFabricTag + apply Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + networkuuid + the uuid of networks + false + list + list + + + nicuuid + the uuid of nics + false + list + list + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + vmuuid + the uuid of vms + false + list + list + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateObjectStoragePool + Updates object storage pool + false + 4.19.0 + + + id + Object Store ID + true + uuid + + + name + the name for the object store + false + string + + + url + the url for the object store + false + string + + + + + id + the ID of the object store + string + + + name + the name of the object store + string + + + providername + the provider name of the object store + string + + + storagetotal + the total size of the object store + long + + + storageused + the object store currently used size + long + + + url + the url of the object store + string + + + false + + + stopRouter + Stops a router. + true + + + id + the ID of the router + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + lockAccount + This deprecated function used to locks an account. Look for the API DisableAccount instead + false + + + account + Locks the specified account. + true + string + + + domainid + Locks the specified account on this domain. + true + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + deleteProjectInvitation + Deletes project invitation + true + 3.0.0 + + + id + id of the invitation + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricFirewallPolicy + create Tungsten-Fabric firewall policy + true + + + name + Tungsten-Fabric firewall policy name + true + string + + + sequence + the sequence of Tungsten-Fabric firewall policy + true + integer + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + + + firewallrule + list Tungsten-Fabric firewall rule + list + + + name + Tungsten-Fabric firewall policy name + string + + + uuid + Tungsten-Fabric firewall policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateRegion + Updates a region + false + + + id + Id of region to update + true + integer + + + endpoint + updates region with this end point + false + string + + + name + updates region with this name + false + string + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + deleteTrafficType + Deletes traffic type of a physical network + true + 3.0.0 + + + id + traffic type id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listLdapConfigurations + Lists all LDAP configurations + false + 4.2.0 + + + domainid + linked domain + false + uuid + + + hostname + Hostname + false + string + + + keyword + List by keyword + false + string + + + listall + If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain + false + 4.13.2 + boolean + + + page + false + integer + + + pagesize + false + integer + + + port + Port + false + integer + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port the ldap server is running on + int + + + false + + + listProjectRolePermissions + Lists a project's project role permissions + false + 4.15.0 + + + projectid + ID of the project + true + uuid + + + projectroleid + ID of the project role + false + uuid + + + + + id + the ID of the project role permission + string + + + projectid + the ID of the project + string + + + projectroleid + the ID of the project role to which the role permission belongs + string + + + projectrolename + the name of the project role to which the role permission belongs + string + + + false + + + createRemoteAccessVpn + Creates a l2tp/ipsec remote access vpn + true + + + publicipid + public ip address id of the vpn server + true + uuid + + + account + an optional account for the VPN. Must be used with domainId. + false + string + + + domainid + an optional domainId for the VPN. If the account parameter is used, domainId must also be used. + false + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + iprange + the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server + false + string + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default + false + boolean + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + changeServiceForVirtualMachine + (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect. + false + + + id + The ID of the virtual machine + true + uuid + + + serviceofferingid + the service offering ID to apply to the virtual machine + true + uuid + + + automigrate + Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering + false + 4.17 + boolean + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + maxiops + New maximum number of IOPS for the custom disk offering + false + 4.17 + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + 4.17 + long + + + shrinkok + Verify OK to Shrink + false + 4.17 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + true + + + listGuestOsMapping + Lists all available OS mappings for given hypervisor + false + 4.4.0 + + + hypervisor + list Guest OS mapping by hypervisor + false + string + + + hypervisorversion + list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter + false + string + + + id + list mapping by its UUID + false + uuid + + + keyword + List by keyword + false + string + + + osdisplayname + list Guest OS mapping by OS display name + false + string + + + osnameforhypervisor + list Guest OS mapping by OS mapping name with hypervisor + false + string + + + ostypeid + list mapping by Guest OS Type UUID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + listTemplates + List all public, private, and privileged templates. + false + + + templatefilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + details + comma separated list of template details requested, value can be a list of [ all, min] + false + list + 4.15 + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + the template ID + false + uuid + + + ids + the IDs of the templates, mutually exclusive with id + false + list + 4.9 + list + + + imagestoreid + ID of the image or image cache store + false + 4.19 + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list VNF templates or not; true if need to list VNF templates, false otherwise. + false + 4.19.0 + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the template name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parenttemplateid + list datadisk templates by parent template id + false + 4.4 + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the templates + false + boolean + + + showremoved + show removed templates as well + false + boolean + + + showunique + If set to true, list only unique templates across zones + false + 4.13.2 + boolean + + + storageid + ID of the storage pool + false + 4.19 + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templatetype + the type of the template + false + 4.19.0 + string + + + zoneid + list templates by zoneId + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTungstenFabricPolicy + create Tungsten-Fabric policy + true + + + name + Tungsten-Fabric policy name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createBucket + Creates a bucket in the specified object storage pool. + true + 4.19.0 + + + name + the name of the bucket + true + string + + + objectstorageid + Id of the Object Storage Pool where bucket is created + true + uuid + + + account + the account associated with the bucket. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain. + false + uuid + + + encryption + Enable bucket encryption + false + boolean + + + objectlocking + Enable object locking in bucket + false + boolean + + + policy + The Bucket access policy + false + string + + + projectid + the project associated with the bucket. Mutually exclusive with account parameter + false + uuid + + + quota + Bucket Quota in GB + false + integer + + + versioning + Enable bucket versioning + false + boolean + + + + + id + ID of the Bucket + string + + + accesskey + Bucket Access Key + string + + + account + the account associated with the Bucket + string + + + created + the date the Bucket was created + date + + + domain + the domain associated with the bucket + string + + + domainid + the ID of the domain associated with the bucket + string + + + domainpath + path of the domain to which the bucket belongs + 4.19.2.0 + string + + + encryption + Bucket Encryption + boolean + + + name + name of the Bucket + string + + + objectlocking + Bucket Object Locking + boolean + + + objectstorageid + id of the object storage hosting the Bucket; returned to admin user only + string + + + objectstore + Name of the object storage hosting the Bucket; returned to admin user only + string + + + policy + Bucket Access Policy + string + + + project + the project name of the bucket + string + + + projectid + the project id of the bucket + string + + + provider + Object storage provider + string + + + quota + Bucket Quota in GB + integer + + + size + Total size of objects in Bucket + long + + + state + State of the Bucket + string + + + url + Bucket URL + string + + + usersecretkey + Bucket Secret Key + string + + + versioning + Bucket Versioning + boolean + + + false + + + listPhysicalNetworks + Lists physical networks + false + 3.0.0 + + + id + list physical network by id + false + uuid + + + keyword + List by keyword + false + string + + + name + search by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the Zone ID for the physical network + false + uuid + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + listFirewallRules + Lists all firewall rules for an IP address. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the firewall services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list firewall rules for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteBrocadeVcsDevice + delete a Brocade VCS Switch + true + + + vcsdeviceid + Brocade Switch ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + extractIso + Extracts an ISO + true + + + id + the ID of the ISO file + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + url + the URL to which the ISO would be extracted + false + string + + + zoneid + the ID of the zone where the ISO is originally located + false + uuid + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + createAffinityGroup + Creates an affinity/anti-affinity group + true + + + name + name of the affinity group + true + string + + + type + Type of the affinity group from the available affinity/anti-affinity group types + true + string + + + account + an account for the affinity group. Must be used with domainId. + false + string + + + description + optional description of the affinity group + false + string + + + domainid + domainId of the account owning the affinity group + false + uuid + + + projectid + create affinity group for project + false + uuid + + + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + false + + + oauthlogin + Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired. + false + 4.19.0 + + + email + Email id with which user tried to login using OAuth provider + true + string + + + provider + Name of the provider + true + string + + + domain + Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed. + false + string + + + domainId + The id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precedence. + false + long + + + secretcode + Code that is provided by OAuth provider (Eg. google, github) after successful login + false + string + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + listInternalLoadBalancerElements + Lists all available Internal Load Balancer elements. + false + 4.2.0 + + + enabled + list internal load balancer elements by enabled state + false + boolean + + + id + list internal load balancer elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list internal load balancer elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + getHypervisorGuestOsNames + Gets the guest OS names in the hypervisor + true + 4.19.0 + + + hypervisor + Hypervisor type. One of : VMware, XenServer + true + string + + + hypervisorversion + Hypervisor version to get the guest os names (atleast one hypervisor host with the version specified must be available) + true + string + + + keyword + Keyword for guest os name + false + string + + + + + guestoscount + the guest OS count of the hypervisor + integer + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for guest os names + string + + + guestoslist(*) + the guest OS list of the hypervisor + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + list + + + false + + + createTungstenFabricProvider + Create Tungsten-Fabric provider in cloudstack + false + + + name + Tungsten-Fabric provider name + true + string + + + tungstengateway + Tungsten-Fabric provider gateway + true + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + true + string + + + zoneid + the ID of zone + true + uuid + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + false + string + + + tungstenproviderport + Tungsten-Fabric provider port + false + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + false + string + + + + + name + Tungsten-Fabric provider name + string + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + tungstengateway + Tungsten-Fabric provider gateway + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + string + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + string + + + tungstenproviderport + Tungsten-Fabric provider port + string + + + tungstenprovideruuid + Tungsten-Fabric provider uuid + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + enableHAForCluster + Enables HA cluster-wide + true + 4.11 + + + clusterid + ID of the cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + rebootVirtualMachine + Reboots a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + bootintosetup + Boot into hardware setup menu or not + false + 4.15.0.0 + boolean + + + forced + Force reboot the VM (VM is Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addVirtualMachinesToKubernetesCluster + Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters. + false + 4.19.0 + + + id + the ID of the Kubernetes cluster + true + uuid + + + virtualmachineids + the IDs of the VMs to add to the cluster + true + list + list + + + iscontrolnode + Is control node or not? Defaults to false. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricLogicalRouter + list Tungsten-Fabric logical router + false + + + keyword + List by keyword + false + string + + + logicalrouteruuid + the uuid of Tungsten-Fabric logical router + false + string + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listBackupOfferings + Lists backup offerings + false + 4.14.0 + + + id + The backup offering ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + The zone ID + false + uuid + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + addGuestOsMapping + Adds a guest OS name to hypervisor OS name mapping + true + 4.4.0 + + + hypervisor + Hypervisor type. One of : XenServer, KVM, VMWare + true + string + + + hypervisorversion + Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version + true + string + + + osnameforhypervisor + OS name specific to the hypervisor + true + string + + + forced + Forces add user defined guest os mapping, overrides any existing user defined mapping + false + 4.19.0 + boolean + + + osdisplayname + Display Name of Guest OS standard type. Either Display Name or UUID must be passed + false + string + + + osmappingcheckenabled + When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.) + false + 4.19.0 + boolean + + + ostypeid + UUID of Guest OS type. Either the UUID or Display Name must be passed + false + uuid + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + listVnfTemplates + List all public, private, and privileged VNF templates. + false + 4.19.0 + + + templatefilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + details + comma separated list of template details requested, value can be a list of [ all, min] + false + list + 4.15 + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + the template ID + false + uuid + + + ids + the IDs of the templates, mutually exclusive with id + false + list + 4.9 + list + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list VNF templates or not; true if need to list VNF templates, false otherwise. + false + 4.19.0 + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the template name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parenttemplateid + list datadisk templates by parent template id + false + 4.4 + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the templates + false + boolean + + + showremoved + show removed templates as well + false + boolean + + + showunique + If set to true, list only unique templates across zones + false + 4.13.2 + boolean + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templatetype + the type of the template + false + 4.19.0 + string + + + zoneid + list templates by zoneId + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deployVnfAppliance + Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template. + true + 4.19.0 + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter + false + list + list + + + bootintosetup + Boot into hardware setup or not (ignored if startVm = false, only valid for vmware) + false + 4.15.0.0 + boolean + + + bootmode + Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + boottype + Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + copyimagetags + if true the image tags (if any) will be copied to the VM, default value is false + false + 4.13 + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter + false + map + 4.11 + map + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + details + used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details + false + map + 4.3 + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + diskofferingid + the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created. + false + uuid + + + displayname + an optional user generated name for the virtual machine + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + 4.2 + boolean + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain. + false + uuid + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable + false + 4.16 + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + an optional group for the virtual machine + false + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + uuid + + + hypervisor + the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call + false + string + + + iodriverpolicy + Controls specific policies on IO + false + string + + + iothreadsenabled + IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs. + false + boolean + + + ip6address + the ipv6 address for default vm's network + false + string + + + ipaddress + the ip address for default vm's network + false + string + + + iptonetworklist + ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid + false + map + map + + + keyboard + an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us + false + string + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs used to login to the virtual machine + false + list + 4.17 + list + + + macaddress + the mac address for default vm's network + false + string + + + name + host name for the virtual machine + false + string + + + networkids + list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter + false + list + list + + + nicmultiqueuenumber + The number of queues for multiqueue NICs. + false + 4.18 + integer + + + nicnetworklist + VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid + false + map + 4.15 + map + + + nicpackedvirtqueuesenabled + Enable packed virtqueues or not. + false + 4.18 + boolean + + + overridediskofferingid + the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id + false + 4.17 + uuid + + + password + The password of the virtual machine. If null, a random password will be generated for the VM. + false + 4.19.0.0 + string + + + projectid + Deploy vm for the project + false + uuid + + + properties + used to specify the vApp properties. + false + map + 4.15 + map + + + rootdisksize + Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.4 + long + + + securitygroupids + comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + size + the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId + false + long + + + startvm + true if start vm after creating; defaulted to true if not specified + false + boolean + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the Userdata + false + 4.18 + uuid + + + vnfcidrlist + the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0. + false + list + list + + + vnfconfiguremanagement + True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups. + false + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateNetworkOffering + Updates a network offering. + false + + + availability + the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required + false + string + + + displaytext + the display text of the network offering + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + id + the id of the network offering + false + uuid + + + keepaliveenabled + if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file. + false + boolean + + + maxconnections + maximum number of concurrent connections supported by the network offering + false + integer + + + name + the name of the network offering + false + string + + + sortkey + sort key of the network offering, integer + false + integer + + + state + update state for the network offering + false + string + + + tags + the tags for the network offering. + false + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + changeOutOfBandManagementPassword + Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + password + the new host management interface password of maximum length 16, if none is provided a random password would be used + false + string + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listResourceDetails + List resource detail(s) + false + 4.2 + + + resourcetype + list by resource type + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + if set to true, only details marked with display=true, are returned. False by default + false + 4.3 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + key + list by key + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + list by resource id + false + string + + + value + list by key, value. Needs to be passed only along with key + false + 4.4 + string + + + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + false + + + createNetworkOffering + Creates a network offering. + false + 3.0.0 + + + guestiptype + guest type of the network offering: Shared or Isolated + true + string + + + name + the name of the network offering + true + string + + + traffictype + the traffic type for the network offering. Supported type in current release is GUEST only + true + string + + + availability + the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks + false + string + + + conservemode + true if the network offering is IP conserve mode enabled + false + boolean + + + details + Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup + false + map + 4.2.0 + map + + + displaytext + the display text of the network offering, defaults to the value of 'name'. + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + false + boolean + + + enable + set to true if the offering is to be enabled during creation. Default is false + false + 4.16 + boolean + + + fortungsten + true if network offering is meant to be used for Tungsten-Fabric, false otherwise. + false + boolean + + + forvpc + true if network offering is meant to be used for VPC, false otherwise. + false + boolean + + + internetprotocol + The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6 + false + 4.17.0 + string + + + ispersistent + true if network offering supports persistent networks; defaulted to false if not specified + false + boolean + + + keepaliveenabled + if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file. + false + boolean + + + maxconnections + maximum number of concurrent connections supported by the network offering + false + integer + + + networkrate + data transfer rate in megabits per second allowed + false + integer + + + servicecapabilitylist + desired service capabilities as part of network offering + false + map + map + + + serviceofferingid + the service offering ID used by virtual router provider + false + uuid + + + serviceproviderlist + provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network + false + map + map + + + specifyipranges + true if network offering supports specifying ip ranges; defaulted to false if not specified + false + boolean + + + specifyvlan + true if network offering supports vlans + false + boolean + + + supportedservices + services supported by the network offering + false + list + list + + + tags + the tags for the network offering. + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + dedicateCluster + Dedicate an existing cluster + true + + + clusterid + the ID of the Cluster + true + uuid + + + domainid + the ID of the containing domain + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the cluster + string + + + affinitygroupid + the Dedication Affinity Group ID of the cluster + string + + + clusterid + the ID of the cluster + string + + + clustername + the name of the cluster + string + + + domainid + the domain ID of the cluster + string + + + false + + + createIpForwardingRule + Creates an IP forwarding rule + true + + + ipaddressid + the public IP address ID of the forwarding rule, already associated via associateIp + true + uuid + + + protocol + the protocol for the rule. Valid values are TCP or UDP. + true + string + + + startport + the start port for the rule + true + integer + + + cidrlist + the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use. + false + list + list + + + endport + the end port for the rule + false + integer + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default + false + boolean + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listElastistorInterface + Lists the network Interfaces of elastistor + false + + + controllerid + controller id + false + string + + + + + id + the id of the volume + string + + + compression + compression + string + + + deduplication + deduplication + string + + + graceallowed + graceallowed + string + + + name + the name of the volume + string + + + sync + synchronization + string + + + false + + + quotaStatement + Create a quota statement + false + 4.7.0 + + + account + Optional, Account Id for which statement needs to be generated + true + string + + + domainid + Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain. + true + uuid + + + enddate + End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + true + date + + + startdate + Start date range quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + true + date + + + accountid + List usage records for the specified account + false + uuid + + + type + List quota usage records for the specified usage type + false + integer + + + + + account + account name + string + + + accountid + account id + long + + + domain + domain id + long + + + name + usage type name + string + + + quota + quota consumed + bigdecimal + + + type + usage type + int + + + unit + usage unit + string + + + false + + + updateLBStickinessPolicy + Updates load balancer stickiness policy + true + 4.4 + + + id + id of lb stickiness policy + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + listPods + Lists all Pods. + false + + + allocationstate + list pods by allocation state + false + string + + + id + list Pods by ID + false + uuid + + + keyword + List by keyword + false + string + + + name + list Pods by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the pods + false + boolean + + + zoneid + list Pods by Zone ID + false + uuid + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + deleteTungstenFabricAddressGroup + delete Tungsten-Fabric address group + true + + + addressgroupuuid + the uuid of Tungsten-Fabric address group + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaTariffList + Lists all quota tariff plans + false + 4.7.0 + + + enddate + The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2021-11-03. + false + 4.18.0.0 + date + + + keyword + List by keyword + false + string + + + listall + False will list only not removed quota tariffs. If set to True, we will list all, including the removed ones. The default is false. + false + 4.18.0.0 + boolean + + + name + The name of the quota tariff. + false + 4.18.0.0 + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + The start date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + usagetype + Usage type of the resource + false + integer + + + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + uuid + uuid + string + + + false + + + stopKubernetesCluster + Stops a running CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addAccountToProject + Adds account to a project + true + 3.0.0 + + + projectid + ID of the project to add the account to + true + uuid + + + account + name of the account to be added to the project + false + string + + + email + email to which invitation to the project is going to be sent + false + string + + + projectroleid + ID of the project role + false + uuid + + + roletype + Project role type to be assigned to the user - Admin/Regular; default: Regular + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSnapshots + Lists all available snapshots for the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + lists snapshot by snapshot ID + false + uuid + + + ids + the IDs of the snapshots, mutually exclusive with id + false + list + 4.9 + list + + + imagestoreid + ID of the image or image cache store + false + 4.19 + uuid + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY. + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + locationtype + list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty + false + 4.19.0 + string + + + name + lists snapshot by snapshot name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showunique + If set to false, list templates across zones and their storages + false + 4.19.0 + boolean + + + snapshottype + valid values are MANUAL or RECURRING. + false + string + + + storageid + ID of the storage pool + false + 4.19 + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + volumeid + the ID of the disk volume + false + uuid + + + zoneid + list snapshots by zone id + false + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + migrateResourceToAnotherSecondaryStorage + migrates resources from one secondary storage to destination image store + true + 4.19.0 + + + destpool + id of the destination secondary storage pool to which the resources are to be migrated + true + uuid + + + srcpool + id of the image store from where the data is to be migrated + true + uuid + + + snapshots + id(s) of the snapshots to be migrated + false + list + list + + + templates + id(s) of the templates to be migrated + false + list + list + + + + + message + Response message from migration of secondary storage data objects + string + + + migrationtype + Type of migration requested for + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSSHKeyPair + Deletes a keypair by name + false + + + name + Name of the keypair + true + string + + + account + the account associated with the keypair. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the keypair + false + uuid + + + projectid + the project associated with keypair + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + searchLdap + Searches LDAP based on the username attribute + false + 4.2.0 + + + query + query to search using + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + readyForShutdown + Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown + false + 4.19.0 + + + managementserverid + the uuid of the management server + false + uuid + + + + + managementserverid + The id of the management server + long + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + createTungstenFabricLogicalRouter + create Tungsten-Fabric logical router + true + + + name + Tungsten-Fabric logical router name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createTungstenFabricFirewallRule + create Tungsten-Fabric firewall + true + + + action + Tungsten-Fabric firewall rule action + true + string + + + direction + Tungsten-Fabric firewall rule direction + true + string + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + true + string + + + name + Tungsten-Fabric firewall rule name + true + string + + + sequence + the sequence of Tungsten-Fabric firewall rule + true + integer + + + servicegroupuuid + Tungsten-Fabric firewall rule service group uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + destaddressgroupuuid + Tungsten-Fabric firewall rule destination address group uuid + false + string + + + destnetworkuuid + the uuid of Tungsten-Fabric destination network + false + string + + + desttaguuid + Tungsten-Fabric firewall rule destination tag uuid + false + string + + + srcaddressgroupuuid + Tungsten-Fabric firewall rule source address group uuid + false + string + + + srcnetworkuuid + the uuid of Tungsten-Fabric source network + false + string + + + srctaguuid + Tungsten-Fabric firewall rule source tag uuid + false + string + + + tagtypeuuid + Tungsten-Fabric firewall rule tag type uuid + false + string + + + + + action + Tungsten-Fabric firewall rule action + string + + + destaddressgroup + Tungsten-Fabric firewall rule destination address group + string + + + destnetwork + Tungsten-Fabric firewall rule destination network + string + + + desttag + Tungsten-Fabric firewall rule destination tag + string + + + direction + Tungsten-Fabric firewall rule direction + string + + + name + Tungsten-Fabric firewall rule name + string + + + servicegroup + Tungsten-Fabric firewall rule service group + string + + + srcaddressgroup + Tungsten-Fabric firewall rule source address group + string + + + srcnetwork + Tungsten-Fabric firewall rule source network + string + + + srctag + Tungsten-Fabric firewall rule source tag + string + + + tagtype + Tungsten-Fabric firewall rule tag type + string + + + uuid + Tungsten-Fabric firewall rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listConfigurations + Lists all configurations. + false + + + accountid + the ID of the Account to update the parameter value for corresponding account + false + uuid + + + category + lists configurations by category + false + string + + + clusterid + the ID of the Cluster to update the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to update the parameter value for corresponding domain + false + uuid + + + group + lists configuration by group name (primarily used for UI) + false + 4.18.0 + string + + + imagestoreuuid + the ID of the Image Store to update the parameter value for corresponding image store + false + uuid + + + keyword + List by keyword + false + string + + + name + lists configuration by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parent + lists configuration by parent name (primarily used for UI) + false + 4.18.0 + string + + + storageid + the ID of the Storage pool to update the parameter value for corresponding storage pool + false + uuid + + + subgroup + lists configuration by subgroup name (primarily used for UI) + false + 4.18.0 + string + + + zoneid + the ID of the Zone to update the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + stopNetScalerVpx + Stops a NetScalervm. + true + + + id + the ID of the NetScaler vm + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + scaleKubernetesCluster + Scales a created, running or stopped CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + false + boolean + + + maxsize + Maximum number of worker nodes in the cluster + false + long + + + minsize + Minimum number of worker nodes in the cluster + false + long + + + nodeids + the IDs of the nodes to be removed + false + list + list + + + serviceofferingid + the ID of the service offering for the virtual machines in the cluster. + false + uuid + + + size + number of Kubernetes cluster nodes + false + long + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + deleteInstanceGroup + Deletes a vm group + false + + + id + the ID of the instance group + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateTrafficType + Updates traffic type of a physical network + true + 3.0.0 + + + id + traffic type id + true + uuid + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a Hyperv host + false + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + false + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + false + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + false + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + false + string + + + + + id + id of the network provider + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a HyperV host + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + string + + + physicalnetworkid + the physical network this belongs to + string + + + traffictype + the trafficType to be added to the physical network + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + string + + + false + + + listConditions + List Conditions for VM auto scaling + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + counterid + Counter-id of the condition. + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + ID of the Condition. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + policyid + the ID of the policy + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the id of the Condition + string + + + account + the owner of the Condition. + string + + + counter + Details of the Counter. + counterresponse + + + counterid + the Id of the Counter. + string + + + countername + the Name of the Counter. + string + + + domain + the domain name of the owner. + string + + + domainid + the domain id of the Condition owner + string + + + domainpath + path of the domain to which the Condition owner belongs + 4.19.2.0 + string + + + project + the project name of the Condition + string + + + projectid + the project id of the Condition. + string + + + relationaloperator + Relational Operator to be used with threshold. + string + + + threshold + Threshold Value for the counter. + long + + + zoneid + zone id of counter + string + + + false + + + migrateSecondaryStorageData + migrates data objects from one secondary storage to destination image store(s) + true + 4.15.0 + + + destpools + id(s) of the destination secondary storage pool(s) to which the templates are to be migrated + true + list + list + + + srcpool + id of the image store from where the data is to be migrated + true + uuid + + + migrationtype + Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete + false + string + + + + + message + Response message from migration of secondary storage data objects + string + + + migrationtype + Type of migration requested for + string + + + success + true if operation is executed successfully + boolean + + + false + + + destroyVolume + Destroys a Volume. + true + 4.14.0 + + + id + The ID of the volume + true + uuid + + + expunge + If true is passed, the volume is expunged immediately. False by default. + false + 4.6.0 + boolean + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addTrafficType + Adds traffic type to a physical network + true + 3.0.0 + + + physicalnetworkid + the Physical Network ID + true + uuid + + + traffictype + the trafficType to be added to the physical network + true + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a Hyperv host + false + string + + + isolationmethod + Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'. + false + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + false + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + false + string + + + vlan + The VLAN id to be used for Management traffic by VMware host + false + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + false + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + false + string + + + + + id + id of the network provider + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a HyperV host + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + string + + + physicalnetworkid + the physical network this belongs to + string + + + traffictype + the trafficType to be added to the physical network + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + string + + + false + + + listSecondaryStorageSelectors + Lists the secondary storage selectors and their rules. + false + 4.19.0 + + + zoneid + The zone ID to be used in the search filter. + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + showremoved + Show removed heuristics. + false + boolean + + + type + Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + false + string + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + listLoadBalancerRuleInstances + List all virtual machine instances that are assigned to a load balancer rule. + false + + + id + the ID of the load balancer rule + true + uuid + + + applied + true if listing all virtual machines currently applied to the load balancer rule; default is true + false + boolean + + + keyword + List by keyword + false + string + + + lbvmips + true if load balancer rule VM IP information to be included; default is false + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + + + lbvmipaddresses + IP addresses of the vm set of lb rule + list + + + loadbalancerruleinstance + the user vm set for lb rule + uservmresponse + + + false + + + deleteCondition + Removes a condition for VM auto scaling + true + + + id + the ID of the condition. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updatePhysicalNetwork + Updates a physical network + true + 3.0.0 + + + id + physical network id + true + uuid + + + networkspeed + the speed for the physical network[1G/10G] + false + string + + + state + Enabled/Disabled + false + string + + + tags + Tag the physical network + false + list + list + + + vlan + the VLAN for the physical network + false + string + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + createTungstenFabricManagementNetwork + create Tungsten-Fabric management network + false + + + podid + the ID of pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricFirewallRule + list Tungsten-Fabric firewall rule + false + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + false + string + + + firewallruleuuid + the uuid of Tungsten-Fabric firewall rule + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + action + Tungsten-Fabric firewall rule action + string + + + destaddressgroup + Tungsten-Fabric firewall rule destination address group + string + + + destnetwork + Tungsten-Fabric firewall rule destination network + string + + + desttag + Tungsten-Fabric firewall rule destination tag + string + + + direction + Tungsten-Fabric firewall rule direction + string + + + name + Tungsten-Fabric firewall rule name + string + + + servicegroup + Tungsten-Fabric firewall rule service group + string + + + srcaddressgroup + Tungsten-Fabric firewall rule source address group + string + + + srcnetwork + Tungsten-Fabric firewall rule source network + string + + + srctag + Tungsten-Fabric firewall rule source tag + string + + + tagtype + Tungsten-Fabric firewall rule tag type + string + + + uuid + Tungsten-Fabric firewall rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createProject + Creates a project + true + 3.0.0 + + + name + name of the project + true + string + + + account + account who will be Admin for the project + false + string + + + accountid + ID of the account owning a project + false + uuid + + + displaytext + The display text of the project, defaults to the 'name´. + false + string + + + domainid + domain ID of the account owning a project + false + uuid + + + userid + user ID of the account to be assigned as owner of the project i.e., Project Admin + false + 4.15.0 + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + addCiscoVnmcResource + Adds a Cisco Vnmc Controller + false + + + hostname + Hostname or ip address of the Cisco VNMC Controller. + true + string + + + password + Credentials to access the Cisco VNMC Controller API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Credentials to access the Cisco VNMC Controller API + true + string + + + + false + + + assignCertToLoadBalancer + Assigns a certificate to a load balancer rule + true + + + certid + the ID of the certificate + true + uuid + + + lbruleid + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + markDefaultZoneForAccount + Marks a default zone for this account + true + 4.0 + + + account + Name of the account that is to be marked. + true + string + + + domainid + Marks the account that belongs to the specified domain. + true + uuid + + + zoneid + The Zone ID with which the account is to be marked. + true + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + revokeCertificate + Revokes certificate using configured CA plugin + true + 4.11.0 + + + serial + The certificate serial number, as a hex value + true + string + + + cn + The certificate CN + false + string + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + changeServiceForSystemVm + Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect. + false + + + id + The ID of the system vm + true + uuid + + + serviceofferingid + the service offering ID to apply to the system vm + true + uuid + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + updateSiocInfo + Update SIOC info + false + 4.11.0 + + + iopsnotifythreshold + Notify if IOPS above this value + true + integer + + + limitiopspergb + Limit IOPS per GB + true + integer + + + sharespergb + Shares per GB + true + integer + + + storageid + Storage Pool ID + true + uuid + + + zoneid + Zone ID + true + uuid + + + + + msg + The return message from the operation ('Success' if successful) + string + + + false + + + cloudianSsoLogin + Generates single-sign-on login url for logged-in CloudStack user to access the Cloudian Management Console + false + 4.11.0 + + + + url + the sso redirect url + string + + + false + + + deleteVMSnapshot + Deletes a vmsnapshot. + true + 4.2.0 + + + vmsnapshotid + The ID of the VM snapshot + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + unmanageVirtualMachine + Unmanage a guest virtual machine. + true + 4.15.0 + + + id + The ID of the virtual machine to unmanage + true + uuid + + + + + details + details of the unmanage VM operation + string + + + success + result of the unmanage VM operation + boolean + + + false + + + rebootRouter + Starts a router. + true + + + id + the ID of the router + true + uuid + + + forced + Force reboot the router (Router is force Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listNics + list the vm nics IP to NIC + false + + + virtualmachineid + the ID of the vm + true + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + keyword + List by keyword + false + string + + + networkid + list nic of the specific vm's network + false + uuid + + + nicid + the ID of the nic to list IPs + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + false + + + createSnapshotFromVMSnapshot + Creates an instant snapshot of a volume from existing vm snapshot. + true + 4.10.0 + + + vmsnapshotid + The ID of the VM snapshot + true + uuid + + + volumeid + The ID of the disk volume + true + uuid + + + name + the name of the snapshot + false + string + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listImageStoreObjects + Lists objects at specified path on an image store. + false + 4.19.0 + + + id + id of the image store + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + path to list on image store + false + string + + + + + format + Format of template associated with the data store object. + string + + + isdirectory + Is it a directory. + boolean + + + lastupdated + Last modified date of the file/directory. + date + + + name + Name of the data store object. + string + + + size + Size is in Bytes. + long + + + snapshotid + Snapshot ID associated with the data store object. + string + + + templateid + Template ID associated with the data store object. + string + + + volumeid + Volume ID associated with the data store object. + string + + + false + + + dedicateGuestVlanRange + Dedicates a guest vlan range to an account + false + + + physicalnetworkid + physical network ID of the vlan + true + uuid + + + vlanrange + guest vlan range to be dedicated + true + string + + + account + account who will own the VLAN + false + string + + + domainid + domain ID of the account owning a VLAN + false + uuid + + + projectid + project who will own the VLAN + false + uuid + + + + + id + the ID of the guest VLAN range + string + + + account + the account of the guest VLAN range + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + domainpath + path of the domain to which the guest VLAN range belongs + 4.19.2.0 + string + + + guestvlanrange + the guest VLAN range + string + + + physicalnetworkid + the physical network of the guest vlan range + long + + + project + the project name of the guest vlan range + string + + + projectid + the project id of the guest vlan range + string + + + zoneid + the zone of the guest vlan range + long + + + false + + + updateIso + Updates an ISO file. + false + + + id + the ID of the image file + true + uuid + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteCounter + Deletes a counter for VM auto scaling + true + + + id + the ID of the counter + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + issueCertificate + Issues a client certificate using configured or provided CA plugin + true + 4.11.0 + + + csr + The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered + false + string + + + domain + Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN + false + string + + + duration + Certificate validity duration in number of days, when not provided the default configured value will be used + false + integer + + + ipaddress + Comma separated list of IP addresses, the certificate should be issued for + false + string + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + cacertificates + The CA certificate(s) + string + + + certificate + The client certificate + string + + + privatekey + Private key for the certificate + string + + + false + + + createPortForwardingRule + Creates a port forwarding rule + true + + + ipaddressid + the IP address id of the port forwarding rule + true + uuid + + + privateport + the starting port of port forwarding rule's private port range + true + integer + + + protocol + the protocol for the port forwarding rule. Valid values are TCP or UDP. + true + string + + + publicport + the starting port of port forwarding rule's public port range + true + integer + + + virtualmachineid + the ID of the virtual machine for the port forwarding rule + true + uuid + + + cidrlist + the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use. + false + list + list + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + networkid + the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case). + false + uuid + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true + false + boolean + + + privateendport + the ending port of port forwarding rule's private port range + false + integer + + + publicendport + the ending port of port forwarding rule's private port range + false + integer + + + vmguestip + VM guest nic secondary IP address for the port forwarding rule + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + dedicateZone + Dedicates a zones. + true + + + domainid + the ID of the containing domain + true + uuid + + + zoneid + the ID of the zone + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Zone is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the zone + string + + + domainid + the domain ID to which the Zone is dedicated + string + + + zoneid + the ID of the Zone + string + + + zonename + the Name of the Zone + string + + + false + + + prepareTemplate + load template into primary storage + false + + + templateid + template ID of the template to be prepared in primary storage(s). + true + uuid + + + zoneid + zone ID of the template to be prepared in primary storage(s). + true + uuid + + + storageid + storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateBackupOffering + Updates a backup offering. + false + 4.16.0 + + + id + The ID of the Backup Offering to be updated + true + uuid + + + allowuserdrivenbackups + Whether to allow user driven backups or not + false + boolean + + + description + The description of the Backup Offering to be updated + false + string + + + name + The name of the Backup Offering to be updated + false + string + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + listBuckets + Lists all Buckets. + false + 4.19.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the bucket + false + uuid + + + ids + the IDs of the Buckets, mutually exclusive with id + false + list + list + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the bucket + false + string + + + objectstorageid + the ID of the object storage pool, available to ROOT admin only + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + ID of the Bucket + string + + + accesskey + Bucket Access Key + string + + + account + the account associated with the Bucket + string + + + created + the date the Bucket was created + date + + + domain + the domain associated with the bucket + string + + + domainid + the ID of the domain associated with the bucket + string + + + domainpath + path of the domain to which the bucket belongs + 4.19.2.0 + string + + + encryption + Bucket Encryption + boolean + + + name + name of the Bucket + string + + + objectlocking + Bucket Object Locking + boolean + + + objectstorageid + id of the object storage hosting the Bucket; returned to admin user only + string + + + objectstore + Name of the object storage hosting the Bucket; returned to admin user only + string + + + policy + Bucket Access Policy + string + + + project + the project name of the bucket + string + + + projectid + the project id of the bucket + string + + + provider + Object storage provider + string + + + quota + Bucket Quota in GB + integer + + + size + Total size of objects in Bucket + long + + + state + State of the Bucket + string + + + url + Bucket URL + string + + + usersecretkey + Bucket Secret Key + string + + + versioning + Bucket Versioning + boolean + + + false + + + stopInternalLoadBalancerVM + Stops an Internal LB vm. + true + + + id + the ID of the internal lb vm + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateSecurityGroup + Updates a security group + false + 4.14.0.0 + + + id + The ID of the security group. + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + name + The new name of the security group. + false + string + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + samlSso + SP initiated SAML Single Sign On + false + + + idpid + Identity Provider Entity ID + true + string + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + createDomain + Creates a domain + false + + + name + creates domain with this name + true + string + + + domainid + Domain UUID, required for adding domain from another Region + false + string + + + networkdomain + Network domain for networks in the domain + false + string + + + parentdomainid + assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed. + false + uuid + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + addImageStore + Adds backup image store. + false + 4.2.0 + + + provider + the image store provider name + true + string + + + details + the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + name + the name for the image store + false + string + + + url + the URL for the image store + false + string + + + zoneid + the Zone ID for the image store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + revokeTemplateDirectDownloadCertificate + Revoke a direct download certificate from hosts in a zone + false + 4.13 + + + zoneid + (optional) zone to revoke certificate + true + uuid + + + hostid + (optional) the host ID to revoke certificate + false + uuid + + + hypervisor + (optional) hypervisor type + false + string + + + id + id of the certificate + false + uuid + + + name + (optional) alias of the SSL certificate + false + string + + + + + details + indicates the details in case of failure or host skipped + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + status + indicates if the certificate has been revoked from the host, failed or skipped + string + + + false + + + updateStorageCapabilities + Syncs capabilities of storage pools + false + 4.16.0 + + + id + Storage pool id + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + assignVolume + Changes ownership of a Volume from one account to another. + false + 4.18.0.0 + + + volumeid + The ID of the volume to be reassigned. + true + uuid + + + accountid + The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'. + false + uuid + + + projectid + The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'. + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteUserData + Deletes a userdata + false + 4.18 + + + id + the ID of the Userdata + true + uuid + + + account + an optional account for the userdata. Must be used with domainId. + false + string + + + domainid + an optional domainId for the userdata. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the userdata + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSupportedNetworkServices + Lists all network services provided by CloudStack or for the given Provider. + false + 3.0.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + network service provider name + false + string + + + service + network service name to list providers and capabilities of + false + string + + + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + false + + + revokeSecurityGroupIngress + Deletes a particular ingress rule from this security group + true + + + id + The ID of the ingress rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addNetworkServiceProvider + Adds a network serviceProvider to a physical network + true + 3.0.0 + + + name + the name for the physical network service provider + true + string + + + physicalnetworkid + the Physical Network ID to add the provider to + true + uuid + + + destinationphysicalnetworkid + the destination Physical Network ID to bridge to + false + uuid + + + servicelist + the list of services to be enabled for this physical network service provider + false + list + list + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + quotaTariffDelete + Marks a quota tariff as removed. + false + 4.18.0.0 + + + id + ID of the quota tariff + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVpnGateway + Delete site to site vpn gateway + true + + + id + id of customer gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createServiceOffering + Creates a service offering. + false + + + name + the name of the service offering + true + string + + + bytesreadrate + bytes read rate of the disk offering + false + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + long + + + byteswriterate + bytes write rate of the disk offering + false + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + long + + + cachemode + the cache mode to use for this disk offering. none, writeback or writethrough + false + 4.14 + string + + + cpunumber + the CPU number of the service offering + false + integer + + + cpuspeed + For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz. +For the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning. + false + integer + + + customized + Whether service offering size is custom or not + false + 4.13 + boolean + + + customizediops + whether compute offering iops is custom or not + false + 4.4 + boolean + + + deploymentplanner + The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used + false + string + + + diskofferingid + the ID of the disk offering to which service offering should be mapped + false + 4.17 + uuid + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + false + 4.17 + boolean + + + displaytext + The display text of the service offering, defaults to 'name'. + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + false + 4.16 + boolean + + + encryptroot + VMs using this offering require root volume encryption + false + 4.18 + boolean + + + hosttags + the host tag for this service offering. + false + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + false + 4.4 + integer + + + iopsreadrate + io requests read rate of the disk offering + false + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + long + + + iopswriterate + io requests write rate of the disk offering + false + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + long + + + issystem + is this a system vm offering + false + boolean + + + isvolatile + true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM + false + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + false + boolean + + + maxcpunumber + The maximum number of CPUs to be set with Custom Computer Offering + false + 4.13 + integer + + + maxiops + max iops of the compute offering + false + 4.4 + long + + + maxmemory + The maximum memory size of the custom service offering in MB + false + 4.13 + integer + + + memory + the total memory of the service offering in MB + false + integer + + + mincpunumber + The minimum number of CPUs to be set with Custom Computer Offering + false + 4.13 + integer + + + miniops + min iops of the compute offering + false + 4.4 + long + + + minmemory + The minimum memory size of the custom service offering in MB + false + 4.13 + integer + + + networkrate + data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtype + false + integer + + + offerha + the HA for the service offering + false + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + false + string + + + rootdisksize + the Root disk size in GB. + false + 4.15 + long + + + serviceofferingdetails + details for planner, used to store specific parameters + false + map + map + + + storagepolicy + Name of the storage policy defined at vCenter, this is applicable only for VMware + false + 4.15 + uuid + + + storagetype + the storage type of the service offering. Values are local and shared. + false + string + + + systemvmtype + the system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm". + false + string + + + tags + the tags for this service offering. + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + state + state of the service offering + string + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + assignVirtualMachine + Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain. + false + 3.0.0 + + + virtualmachineid + id of the VM to be moved + true + uuid + + + account + account name of the new VM owner. + false + string + + + domainid + domain id of the new VM owner. + false + uuid + + + networkids + list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created. + false + list + list + + + projectid + an optional project for the new VM owner. + false + uuid + + + securitygroupids + list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group. + false + list + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVmsForImport + Lists virtual machines on a unmanaged host + false + 4.19.0 + + + host + the host name or IP address + true + string + + + hypervisor + hypervisor type of the host + true + string + + + zoneid + the zone ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + password + the password for the host + false + string + + + username + the username for the host + false + string + + + + + clusterid + the ID of the cluster to which virtual machine belongs + string + + + clustername + the name of the cluster to which virtual machine belongs + string + + + cpucorepersocket + the CPU cores per socket for the virtual machine. VMware specific + integer + + + cpunumber + the CPU cores of the virtual machine + integer + + + cpuspeed + the CPU speed of the virtual machine + integer + + + hostid + the ID of the host to which virtual machine belongs + string + + + hostname + the name of the host to which virtual machine belongs + string + + + memory + the memory of the virtual machine in MB + integer + + + name + the name of the virtual machine + string + + + osdisplayname + the operating system of the virtual machine + string + + + osid + the operating system ID of the virtual machine + string + + + powerstate + the power state of the virtual machine + string + + + disk(*) + the list of disks associated with the virtual machine + + + id + the ID of the disk + string + + + capacity + the capacity of the disk in bytes + long + + + controller + the controller of the disk + string + + + controllerunit + the controller unit of the disk + integer + + + datastorehost + the controller of the disk + string + + + datastorename + the controller of the disk + string + + + datastorepath + the controller of the disk + string + + + datastoretype + the controller of the disk + string + + + imagepath + the file path of the disk image + string + + + label + the label of the disk + string + + + position + the position of the disk + integer + + + set + + + nic(*) + the list of nics associated with the virtual machine + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + configureNetscalerLoadBalancer + configures a netscaler load balancer device + true + + + lbdeviceid + Netscaler load balancer device ID + true + uuid + + + inline + true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall + false + boolean + + + lbdevicecapacity + capacity of the device, Capacity will be interpreted as number of networks device can handle + false + long + + + lbdevicededicated + true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts + false + boolean + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + false + list + list + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + deleteTungstenFabricServiceGroup + delete Tungsten-Fabric service group + true + + + servicegroupuuid + the uuid of Tungsten-Fabric service group + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addObjectStoragePool + Adds a object storage pool + false + 4.19.0 + + + name + the name for the object store + true + string + + + provider + the object store provider name + true + string + + + url + the URL for the object store + true + string + + + details + the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + tags + the tags for the storage pool + false + string + + + + + id + the ID of the object store + string + + + name + the name of the object store + string + + + providername + the provider name of the object store + string + + + storagetotal + the total size of the object store + long + + + storageused + the object store currently used size + long + + + url + the url of the object store + string + + + false + + + deleteUserFromProject + Deletes user from the project + true + 4.15.0 + + + projectid + ID of the project to remove the user from + true + uuid + + + userid + Id of the user to be removed from the project + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkServiceProvider + Deletes a Network Service Provider. + true + 3.0.0 + + + id + the ID of the network service provider + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkDevice + List network devices + false + + + keyword + List by keyword + false + string + + + networkdeviceparameterlist + parameters for network device + false + map + map + + + networkdevicetype + Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the network device + string + + + false + + + listProjectRoles + Lists Project roles in CloudStack + false + 4.15.0 + + + projectid + List project role by project ID. + true + uuid + + + keyword + List by keyword + false + string + + + name + List project role by project role name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectroleid + List project role by project role ID. + false + uuid + + + + + projectid + the id of the project + string + + + false + + + deleteOpenDaylightController + Removes an OpenDyalight controler + true + + + id + OpenDaylight Controller ID + true + uuid + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + updateTemplate + Updates attributes of a template. + false + + + id + the ID of the image file + true + uuid + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + string + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateVpnConnection + Updates site to site vpn connection + true + 4.4 + + + id + id of vpn connection + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + createVlanIpRange + Creates a VLAN IP range. + false + + + account + account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted + false + string + + + domainid + domain ID of the account owning a VLAN + false + uuid + + + endip + the ending IP address in the VLAN IP range + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + forsystemvms + true if IP range is set to system vms, false if not + false + boolean + + + forvirtualnetwork + true if VLAN is of Virtual type, false if Direct + false + boolean + + + gateway + the gateway of the VLAN IP range + false + string + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6gateway + the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC + false + string + + + netmask + the netmask of the VLAN IP range + false + string + + + networkid + the network id + false + uuid + + + physicalnetworkid + the physical network id + false + uuid + + + podid + optional parameter. Have to be specified for Direct Untagged vlan only. + false + uuid + + + projectid + project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted + false + uuid + + + startip + the beginning IP address in the VLAN IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + vlan + the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged + false + string + + + zoneid + the Zone ID of the VLAN IP range + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + listPaloAltoFirewallNetworks + lists network that are using Palo Alto firewall device + false + + + lbdeviceid + palo alto balancer device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getPathForVolume + Get the path associated with the provided volume UUID + false + + + volumeid + CloudStack Volume UUID + true + string + + + + + path + The path field for the volume + string + + + false + + + listManagementServers + Lists management servers. + false + + + id + the id of the management server + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the management server + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the management server + string + + + javadistribution + the java distribution name running the management server process + string + + + javaversion + the version of the java distribution running the management server process + string + + + kernelversion + the running OS kernel version for this Management Server + string + + + lastboottime + the last time the host on which this Management Server runs was booted + date + + + lastserverstart + the last time this Management Server was started + date + + + lastserverstop + the last time this Management Server was stopped + date + + + name + the name of the management server + string + + + osdistribution + the name of the OS distribution running on the management server + string + + + serviceip + the IP Address for this Management Server + string + + + state + the state of the management server + state + + + version + the version of the management server + string + + + false + + + deleteTungstenFabricPolicy + delete Tungsten-Fabric policy + true + + + policyuuid + the Uuid of Tungsten-Fabric tag type + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricPolicyRule + list Tungsten-Fabric policy + false + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + ruleuuid + the uuid of Tungsten-Fabric rule + false + string + + + zoneid + the ID of zone + false + uuid + + + + + action + Tungsten-Fabric policy action + string + + + destendport + Tungsten-Fabric policy destination end port + int + + + destipprefix + Tungsten-Fabric policy destination ip prefix + string + + + destipprefixlen + Tungsten-Fabric policy destination ip prefix length + int + + + destnetwork + Tungsten-Fabric policy destination network + string + + + deststartport + Tungsten-Fabric policy destination start port + int + + + direction + Tungsten-Fabric policy name + string + + + policyuuid + Tungsten-Fabric policy uuid + string + + + protocol + Tungsten-Fabric policy protocol + string + + + srcendport + Tungsten-Fabric policy source end port + int + + + srcipprefix + Tungsten-Fabric policy source ip prefix + string + + + srcipprefixlen + Tungsten-Fabric policy source ip prefix length + int + + + srcnetwork + Tungsten-Fabric policy source network + string + + + srcstartport + Tungsten-Fabric policy source start port + int + + + uuid + Tungsten-Fabric rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateInstanceGroup + Updates a vm group + false + + + id + Instance group ID + true + uuid + + + name + new instance group name + false + string + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + domainpath + path of the Domain the instance group belongs to + 4.19.2.0 + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + listTemplateDirectDownloadCertificates + List the uploaded certificates for direct download templates + false + 4.17.0 + + + id + list direct download certificate by ID + false + uuid + + + keyword + List by keyword + false + string + + + listhosts + if set to true: include the hosts where the certificate is uploaded to + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the zone where certificates are uploaded + false + uuid + + + + + id + the direct download certificate id + string + + + alias + the direct download certificate alias + string + + + hostsmap + the hosts where the certificate is uploaded to + list + + + hypervisor + the hypervisor of the hosts where the certificate is uploaded + string + + + issuer + the direct download certificate issuer + string + + + serialnum + the direct download certificate serial num + string + + + subject + the direct download certificate subject + string + + + validity + the direct download certificate issuer + string + + + version + the direct download certificate version + string + + + zoneid + the zone id where the certificate is uploaded + string + + + zonename + the zone name where the certificate is uploaded + string + + + false + + + listUcsManagers + List ucs manager + false + + + id + the ID of the ucs manager + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the zone id + false + uuid + + + + + id + the ID of the ucs manager + string + + + name + the name of ucs manager + string + + + url + the url of ucs manager + string + + + zoneid + the zone ID of ucs manager + string + + + false + + + changeServiceForRouter + Upgrades domain router to a new service offering + false + + + id + The ID of the router + true + uuid + + + serviceofferingid + the service offering ID to apply to the domain router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateVolume + Updates the volume. + true + + + chaininfo + The chain info of the volume + false + 4.4 + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displayvolume + an optional field, whether to the display the volume to the end user or not. + false + boolean + + + id + the ID of the disk volume + false + uuid + + + name + new name of the volume + false + 4.16 + string + + + path + The path of the volume + false + string + + + state + The state of the volume + false + 4.3 + string + + + storageid + Destination storage pool UUID for the volume + false + 4.3 + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTrafficTypes + Lists traffic types of a given physical network. + false + 3.0.0 + + + physicalnetworkid + the Physical Network ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + addSecondaryStorage + Adds secondary storage. + false + + + url + the URL for the secondary storage + true + string + + + zoneid + the Zone ID for the secondary storage + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + updateVirtualMachine + Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call. + false + + + id + The ID of the virtual machine + true + uuid + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + details + Details in key/value pairs. 'extraconfig' is not allowed to be passed in details. + false + map + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + displayname + user generated name + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + group of the virtual machine + false + string + + + haenable + true if high-availability is enabled for the virtual machine, false otherwise + false + boolean + + + instancename + instance name of the user vm + false + 4.4 + string + + + isdynamicallyscalable + true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting + false + boolean + + + name + new host name of the vm. The VM has to be stopped/started for this update to take affect + false + 4.4 + string + + + ostypeid + the ID of the OS type that best represents this VM. + false + uuid + + + securitygroupids + list of security group ids to be applied on the virtual machine. + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + 4.16.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the userdata + false + 4.18 + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateAccount + Updates account information for the authenticated user + false + + + account + Current account name + false + string + + + accountdetails + Details for the account used to store specific parameters + false + map + map + + + domainid + The UUID of the domain where the account exists + false + uuid + + + id + Account UUID + false + uuid + + + networkdomain + Network domain for the account's networks; empty string will update domainName with NULL value + false + string + + + newname + New name for the account + false + string + + + roleid + The UUID of the dynamic role to set for the account + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + listDomains + Lists domains and provides detailed information for listed domains + false + + + details + comma separated list of domain details requested, value can be a list of [ all, resource, min] + false + list + list + + + id + List domain by domain ID. + false + uuid + + + keyword + List by keyword + false + string + + + level + List domains by domain level. + false + integer + + + listall + 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 + false + boolean + + + name + List domain by domain name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for domains + false + boolean + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + disableAccount + Disables an account + true + + + lock + If true, only lock the account; else disable the account + true + boolean + + + account + Disables specified account. + false + string + + + domainid + Disables specified account in this domain. + false + uuid + + + id + Account id + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + resetUserDataForVirtualMachine + Resets the UserData for virtual machine. The virtual machine must be in a "Stopped" state. [async] + false + + + id + The ID of the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the virtual machine + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + map + + + userdataid + the ID of the userdata + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listNetworkACLLists + Lists all network ACLs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists network ACL with the specified ID. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list network ACLs by specified name + false + string + + + networkid + list network ACLs by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + list network ACLs by VPC ID + false + uuid + + + + + id + the ID of the ACL + string + + + description + Description of the ACL + string + + + fordisplay + is ACL for display to the regular user + 4.4 + boolean + + + name + the Name of the ACL + string + + + vpcid + Id of the VPC this ACL is associated with + string + + + vpcname + Name of the VPC this ACL is associated with + string + + + false + + + deleteTemplate + Deletes a template from the system. All virtual machines using the deleted template will not be affected. + true + + + id + the ID of the template + true + uuid + + + forced + Force delete a template. + false + 4.9+ + boolean + + + zoneid + the ID of zone of the template + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + archiveSnapshot + Archives (moves) a snapshot on primary storage to secondary storage + true + + + id + The ID of the snapshot + true + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateVpnGateway + Updates site to site vpn local gateway + true + 4.4 + + + id + id of customer gateway + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + releaseDedicatedGuestVlanRange + Releases a dedicated guest vlan range to the system + true + + + id + the ID of the dedicated guest vlan range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSecurityGroup + Deletes security group + false + + + account + the account of the security group. Must be specified with domain ID + false + string + + + domainid + the domain ID of account owning the security group + false + uuid + + + id + The ID of the security group. Mutually exclusive with name parameter + false + uuid + + + name + The ID of the security group. Mutually exclusive with id parameter + false + string + + + projectid + the project of the security group + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + importVolume + Import an unmanaged volume from a storage pool on a host into CloudStack + true + 4.19.1 + + + path + the path of the volume + true + string + + + storageid + the ID of the storage pool + true + uuid + + + account + an optional account for the volume. Must be used with domainId. + false + string + + + diskofferingid + the ID of the disk offering linked to the volume + false + uuid + + + domainid + import volume to the domain specified + false + uuid + + + name + the name of the volume. If not set, it will be set to the path of the volume. + false + string + + + projectid + import volume for the project + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTemplate + Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it. + true + + + name + the name of the template + true + string + + + ostypeid + the ID of the OS Type that best represents the OS of this template. + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + 4.19.0 + string + + + bits + 32 or 64 bit + false + integer + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + The display text of the template, defaults to the 'name'. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + 4.19.0 + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if this template is a public template, false otherwise + false + boolean + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + create template for the project + false + uuid + + + requireshvm + true if the template requires HVM, false otherwise + false + boolean + + + snapshotid + the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in + false + uuid + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + url + Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server + false + string + + + virtualmachineid + Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal + false + uuid + + + volumeid + the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in + false + uuid + + + zoneid + the zone for the template. Can be specified with snapshot only + false + 4.19.0 + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + restoreBackup + Restores an existing stopped or deleted VM using a VM backup + true + 4.14.0 + + + id + ID of the backup + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + uploadCustomCertificate + Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself. + true + + + certificate + The certificate to be uploaded. + true + string + + + domainsuffix + DNS domain suffix that the certificate is granted for. + true + string + + + id + An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3 + false + integer + + + name + A name / alias for the certificate. + false + string + + + privatekey + The private key for the attached certificate. + false + string + + + + + message + message of the certificate upload operation + string + + + false + + + listDedicatedClusters + Lists dedicated clusters. + false + + + account + the name of the account associated with the cluster. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated clusters by affinity group + false + uuid + + + clusterid + the ID of the cluster + false + uuid + + + domainid + the ID of the domain associated with the cluster + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the cluster + string + + + affinitygroupid + the Dedication Affinity Group ID of the cluster + string + + + clusterid + the ID of the cluster + string + + + clustername + the name of the cluster + string + + + domainid + the domain ID of the cluster + string + + + false + + + quotaUpdate + Update quota calculations, alerts and statements + false + 4.7.0 + + + + updated_on + timestamp when the run got over + date + + + false + + + listTungstenFabricNetwork + list Tungsten-Fabric network + false + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false + false + boolean + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric network name + string + + + uuid + Tungsten-Fabric network uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listTrafficMonitors + List traffic monitor Hosts. + false + + + zoneid + zone Id + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the external firewall + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + updatePortForwardingRule + Updates a port forwarding rule. Only the private port and the virtual machine can be updated. + true + + + id + the ID of the port forwarding rule + true + 4.4 + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + privateendport + the private end port of the port forwarding rule + false + integer + + + privateport + the private start port of the port forwarding rule + false + integer + + + virtualmachineid + the ID of the virtual machine for the port forwarding rule + false + uuid + + + vmguestip + VM guest nic Secondary ip address for the port forwarding rule + false + 4.5 + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + associateIpAddress + Acquires and associates a public IP to an account. + true + + + account + the account to associate with this IP address + false + string + + + domainid + the ID of the domain to associate with this IP address + false + uuid + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + 4.4 + boolean + + + ipaddress + IP Address to be associated + false + string + + + isportable + should be set to true if public IP is required to be transferable across zones, if not specified defaults to false + false + boolean + + + networkid + The network this IP address should be associated to. + false + uuid + + + projectid + Deploy VM for the project + false + uuid + + + regionid + region ID from where portable IP is to be associated. + false + integer + + + vpcid + the VPC you want the IP address to be associated with + false + uuid + + + zoneid + the ID of the availability zone you want to acquire an public IP address from + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + getSolidFireVolumeAccessGroupIds + Get the SF Volume Access Group IDs + false + + + clusterid + Cluster UUID + true + string + + + storageid + Storage Pool UUID + true + string + + + + + solidFireVolumeAccessGroupIds + SolidFire Volume Access Group Ids + long[] + + + false + + + deleteVpnConnection + Delete site to site vpn connection + true + + + id + id of vpn connection + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAlertTypes + Lists all alerts types + false + + + + id + the id of the alert + string + + + description + description of the alert + string + + + name + the name of the alert + 4.3 + string + + + sent + the date and time the alert was sent + date + + + type + One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29 + short + + + false + + + createNetworkACL + Creates a ACL rule in the given network (the network has to belong to VPC) + true + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + true + string + + + aclid + The network of the VM the ACL will be created for + false + uuid + + + action + scl entry action, allow or deny + false + string + + + cidrlist + the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of ACL + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + networkid + The network of the VM the ACL will be created for + false + uuid + + + number + The number of the ACL item, its ordering + false + integer + + + reason + A description indicating why the ACL rule is required. + false + string + + + startport + the starting port of ACL + false + integer + + + traffictype + the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + resetSSHKeyForVirtualMachine + Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async] + true + + + id + The ID of the virtual machine + true + uuid + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs to be used to login to the virtual machine + false + list + 4.17 + list + + + projectid + an optional project for the ssh key + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteManagementNetworkIpRange + Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated. + true + 4.11.0.0 + + + endip + The ending IP address. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + startip + The starting IP address. + true + string + + + vlan + The vlan id the ip range sits on + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addKubernetesSupportedVersion + Add a supported Kubernetes version + false + + + mincpunumber + the minimum number of CPUs to be set with the Kubernetes version + true + integer + + + minmemory + the minimum RAM size in MB to be set with the Kubernetes version + true + integer + + + semanticversion + the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format + true + string + + + checksum + the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + directdownload + If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false + false + 4.18.2 + boolean + + + name + the name of the Kubernetes supported version + false + string + + + url + the URL of the binaries ISO for Kubernetes supported version + false + string + + + zoneid + the ID of the zone in which Kubernetes supported version will be available + false + uuid + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + directdownload + KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage + 4.18.2 + boolean + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + linkUserDataToTemplate + Link or unlink a userdata to a template. + false + 4.18.0 + + + isoid + the ID of the ISO for the virtual machine + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + userdataid + the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO + false + uuid + + + userdatapolicy + an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride + false + string + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listGlobalLoadBalancerRules + Lists load balancer rules. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the global load balancer rule + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + regionid + region ID + false + integer + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + getKubernetesClusterConfig + Get Kubernetes cluster config + false + + + id + the ID of the Kubernetes cluster + false + uuid + + + + + id + the id of the container cluster + string + + + configdata + the config data of the cluster + string + + + name + Name of the container cluster + string + + + false + + + releaseDedicatedCluster + Release the dedication for cluster + true + + + clusterid + the ID of the Cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteDiskOffering + Updates a disk offering. + false + + + id + ID of the disk offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteAutoScalePolicy + Deletes a autoscale policy. + true + + + id + the ID of the autoscale policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteCiscoNexusVSM + delete a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteRole + Deletes a role + false + 4.9.0 + + + id + ID of the role + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listInternalLoadBalancerVMs + List internal LB VMs. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fetchhealthcheckresults + if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false + false + 4.14 + boolean + + + forvpc + if true is passed for this parameter, list only VPC Internal LB VMs + false + boolean + + + hostid + the host ID of the Internal LB VM + false + uuid + + + id + the ID of the Internal LB VM + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the Internal LB VM + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the Internal LB VM + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + the state of the Internal LB VM + false + string + + + vpcid + List Internal LB VMs by VPC + false + uuid + + + zoneid + the Zone ID of the Internal LB VM + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listCiscoVnmcResources + Lists Cisco VNMC controllers + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + resourceid + Cisco VNMC resource ID + false + uuid + + + + false + + + executeClusterDrsPlan + Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail. + true + 4.19.0 + + + id + ID of cluster + true + uuid + + + migrateto + Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=<uuid>&migrateto[vm-index].host=<uuid> Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm=<uuid> indicates the UUID of the vm that you want to migrate, and host=<uuid> indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc> + false + map + map + + + + + id + unique ID of the drs plan for cluster + string + + + clusterid + Id of the cluster + string + + + eventid + Start event Id of the DRS Plan + string + + + migrations + List of migrations + list + + + status + Status of DRS Plan + status + + + type + Type of DRS Plan (Automated or Manual)) + type + + + false + + + revokeSecurityGroupEgress + Deletes a particular egress rule from this security group + true + 3.0.0 + + + id + The ID of the egress rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + uploadResourceIcon + Uploads an icon for the specified resource(s) + false + 4.16.0.0 + + + base64image + Base64 string representation of the resource icon/image + true + string + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateKubernetesSupportedVersion + Update a supported Kubernetes version + false + + + id + the ID of the Kubernetes supported version + true + uuid + + + state + the enabled or disabled state of the Kubernetes supported version + true + string + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + directdownload + KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage + 4.18.2 + boolean + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + createGuestNetworkIpv6Prefix + Creates a guest network IPv6 prefix. + true + 4.17.0.0 + + + prefix + The /56 or higher IPv6 CIDR for network prefix. + true + string + + + zoneid + UUID of zone to which the IPv6 prefix belongs to. + true + uuid + + + + + id + id of the guest IPv6 prefix + string + + + availablesubnets + count of the available IPv6 subnets for the prefix. + integer + + + created + date when this IPv6 prefix was created. + date + + + prefix + guest IPv6 prefix + string + + + totalsubnets + count of the total IPv6 subnets for the prefix. + integer + + + usedsubnets + count of the used IPv6 subnets for the prefix. + integer + + + zoneid + id of zone to which the IPv6 prefix belongs to. + string + + + false + + + createRole + Creates a role + false + 4.9.0 + + + name + Creates a role with this unique name + true + string + + + description + The description of the role + false + string + + + ispublic + Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true. + false + boolean + + + roleid + ID of the role to be cloned from. Either roleid or type must be passed in + false + uuid + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + getUploadParamsForVolume + Upload a data disk to the cloudstack cloud. + false + 4.6.0 + + + format + the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume/template/iso + true + string + + + zoneid + the ID of the zone the volume/template/iso is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + checksum + the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + diskofferingid + the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown. + false + uuid + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + imagestoreuuid + Image store uuid + false + string + + + projectid + Upload volume/template/iso for the project + false + uuid + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + updateAutoScaleVmProfile + Updates an existing autoscale vm profile. + true + + + id + the ID of the autoscale vm profile + true + uuid + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + false + uuid + + + counterparam + counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161 + false + map + map + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + false + integer + + + fordisplay + an optional field, whether to the display the profile to the end user or not + false + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. +Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 . +Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". + false + map + 4.18.0 + map + + + serviceofferingid + the service offering of the auto deployed virtual machine + false + 4.18.0 + uuid + + + templateid + the template of the auto deployed virtual machine + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + 4.18.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18.1 + map + + + userdataid + the ID of the userdata + false + 4.18.1 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + domainpath + path of the domain to which the vm profile belongs + 4.19.2.0 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base64 encoded VM user data + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.1 + string + + + userdataid + the id of userdata used for the VM + 4.18.1 + string + + + userdataname + the name of userdata used for the VM + 4.18.1 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.1 + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + enableAutoScaleVmGroup + Enables an AutoScale Vm Group + true + + + id + the ID of the autoscale group + true + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + listGuestNetworkIpv6Prefixes + Lists guest network IPv6 prefixes + false + 4.17.0 + + + id + UUID of the IPv6 prefix. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + UUID of zone to which the IPv6 prefix belongs to. + false + uuid + + + + + id + id of the guest IPv6 prefix + string + + + availablesubnets + count of the available IPv6 subnets for the prefix. + integer + + + created + date when this IPv6 prefix was created. + date + + + prefix + guest IPv6 prefix + string + + + totalsubnets + count of the total IPv6 subnets for the prefix. + integer + + + usedsubnets + count of the used IPv6 subnets for the prefix. + integer + + + zoneid + id of zone to which the IPv6 prefix belongs to. + string + + + false + + + updateGuestOsMapping + Updates the information about Guest OS to Hypervisor specific name mapping + true + 4.4.0 + + + id + UUID of the Guest OS to hypervisor name Mapping + true + uuid + + + osnameforhypervisor + Hypervisor specific name for this Guest OS + true + string + + + osmappingcheckenabled + When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.) + false + 4.19.0 + boolean + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + deleteTungstenFabricTag + delete Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateHostPassword + Update password of a host/pool on management server. + false + + + password + the new password for the host/cluster + true + string + + + username + the username for the host/cluster + true + string + + + clusterid + the cluster ID + false + uuid + + + hostid + the host ID + false + uuid + + + update_passwd_on_host + if the password should also be updated on the hosts + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createPortableIpRange + adds a range of portable public IP's to a region + true + 4.2.0 + + + endip + the ending IP address in the portable IP range + true + string + + + gateway + the gateway for the portable IP range + true + string + + + netmask + the netmask of the portable IP range + true + string + + + regionid + Id of the Region + true + integer + + + startip + the beginning IP address in the portable IP range + true + string + + + vlan + VLAN id, if not specified defaulted to untagged + false + string + + + + + id + portable IP range ID + string + + + endip + the end ip of the portable IP range + string + + + gateway + the gateway of the VLAN IP range + string + + + netmask + the netmask of the VLAN IP range + string + + + regionid + Region Id in which portable ip range is provisioned + integer + + + startip + the start ip of the portable IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + portableipaddress(*) + List of portable IP and association with zone/network/vpc details that are part of GSLB rule + + + accountid + the account ID the portable IP address is associated with + string + + + allocated + date the portal IP address was acquired + date + + + domainid + the domain ID the portable IP address is associated with + string + + + ipaddress + public IP address + string + + + networkid + the ID of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + regionid + Region Id in which global load balancer is created + integer + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing and Free + string + + + vpcid + VPC the ip belongs to + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + list + + + false + + + updateCluster + Updates an existing cluster + false + + + id + the ID of the Cluster + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + clustername + the cluster name + false + string + + + clustertype + hypervisor type of the cluster + false + string + + + hypervisor + hypervisor type of the cluster + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + listVmwareDcVms + Lists the VMs in a VMware Datacenter + false + + + datacentername + Name of VMware datacenter. + false + string + + + existingvcenterid + UUID of a linked existing vCenter + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + password + The password for specified username. + false + string + + + username + The Username required to connect to resource. + false + string + + + vcenter + The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + clusterid + the ID of the cluster to which virtual machine belongs + string + + + clustername + the name of the cluster to which virtual machine belongs + string + + + cpucorepersocket + the CPU cores per socket for the virtual machine. VMware specific + integer + + + cpunumber + the CPU cores of the virtual machine + integer + + + cpuspeed + the CPU speed of the virtual machine + integer + + + hostid + the ID of the host to which virtual machine belongs + string + + + hostname + the name of the host to which virtual machine belongs + string + + + memory + the memory of the virtual machine in MB + integer + + + name + the name of the virtual machine + string + + + osdisplayname + the operating system of the virtual machine + string + + + osid + the operating system ID of the virtual machine + string + + + powerstate + the power state of the virtual machine + string + + + disk(*) + the list of disks associated with the virtual machine + + + id + the ID of the disk + string + + + capacity + the capacity of the disk in bytes + long + + + controller + the controller of the disk + string + + + controllerunit + the controller unit of the disk + integer + + + datastorehost + the controller of the disk + string + + + datastorename + the controller of the disk + string + + + datastorepath + the controller of the disk + string + + + datastoretype + the controller of the disk + string + + + imagepath + the file path of the disk image + string + + + label + the label of the disk + string + + + position + the position of the disk + integer + + + set + + + nic(*) + the list of nics associated with the virtual machine + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listUcsProfiles + List profile in ucs manager + false + + + ucsmanagerid + the id for the ucs manager + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + ucsdn + ucs profile dn + string + + + false + + + listStorageProviders + Lists storage providers. + false + + + type + the type of storage provider: either primary or image + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + the name of the storage provider + string + + + type + the type of the storage provider: primary or image provider + string + + + false + + + getUserKeys + This command allows the user to query the seceret and API keys for the account + false + 4.10.0 + + + id + ID of the user whose keys are required + true + uuid + + + + + apikey + the api key of the registered user + string + + + secretkey + the secret key of the registered user + string + + + false + + + updateGlobalLoadBalancerRule + update global load balancer rules. + true + + + id + the ID of the global load balancer rule + true + uuid + + + description + the description of the load balancer rule + false + string + + + gslblbmethod + load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin' + false + string + + + gslbstickysessionmethodname + session sticky method (sourceip) if not specified defaults to sourceip + false + string + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + authorizeSamlSso + Allow or disallow a user to use SAML SSO + false + + + enable + If true, authorizes user to be able to use SAML for Single Sign. If False, disable user to user SAML SSO. + true + boolean + + + userid + User uuid + true + uuid + + + entityid + The Identity Provider ID the user is allowed to get single signed on from + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addGuestOs + Add a new guest OS type + true + 4.4.0 + + + oscategoryid + ID of Guest OS category + true + uuid + + + osdisplayname + Unique display name for Guest OS + true + string + + + details + Map of (key/value pairs) + false + map + map + + + forDisplay + whether this guest OS is available for end users + false + boolean + + + name + Optional name for Guest OS + false + string + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + fordisplay + is the guest OS visible for the users + boolean + + + isuserdefined + is the guest OS user defined + boolean + + + name + the name of the OS type + string + + + oscategoryid + the ID of the OS category + string + + + oscategoryname + the name of the OS category + string + + + false + + + listHostTags + Lists host tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the host tag + string + + + hostid + the host ID of the host tag + long + + + name + the name of the host tag + string + + + false + + + addAnnotation + add an annotation. + false + 4.11 + + + adminsonly + the annotation is visible for admins only + false + 4.16.0 + boolean + + + annotation + the annotation text + false + string + + + entityid + the id of the entity to annotate + false + string + + + entitytype + The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER + false + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + listIdps + Returns list of discovered SAML Identity Providers + false + + + + id + The IdP Entity ID + string + + + orgName + The IdP Organization Name + string + + + orgUrl + The IdP Organization URL + string + + + false + + + deployNetscalerVpx + Creates new NS Vpx + true + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + networkid + The network this ip address should be associated to. + false + uuid + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + listElastistorVolume + Lists the volumes of elastistor + false + + + id + the ID of the account + true + string + + + + + id + the id of the volume + string + + + compression + compression + string + + + deduplication + deduplication + string + + + graceallowed + graceallowed + string + + + name + the name of the volume + string + + + sync + synchronization + string + + + false + + + listNiciraNvpDevices + Lists Nicira NVP devices + false + + + keyword + List by keyword + false + string + + + nvpdeviceid + nicira nvp device ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + hostname + the controller Ip address + string + + + l2gatewayserviceuuid + this L2 gateway service Uuid + string + + + l3gatewayserviceuuid + this L3 gateway service Uuid + string + + + niciradevicename + device name + string + + + nvpdeviceid + device id of the Nicire Nvp + string + + + physicalnetworkid + the physical network to which this Nirica Nvp belongs to + string + + + provider + name of the provider + string + + + transportzoneuuid + the transport zone Uuid + string + + + false + + + addBaremetalPxeKickStartServer + add a baremetal pxe server + true + + + password + Credentials to reach external pxe device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + pxeservertype + type of pxe device + true + string + + + tftpdir + Tftp root directory of PXE server + true + string + + + url + URL of the external pxe device + true + string + + + username + Credentials to reach external pxe device + true + string + + + podid + Pod Id + false + uuid + + + + + tftpdir + Tftp root directory of PXE server + string + + + false + + + listAlerts + Lists all alerts. + false + + + id + the ID of the alert + false + uuid + + + keyword + List by keyword + false + string + + + name + list by alert name + false + 4.3 + string + + + page + false + integer + + + pagesize + false + integer + + + type + list by alert type + false + string + + + + + id + the id of the alert + string + + + description + description of the alert + string + + + name + the name of the alert + 4.3 + string + + + sent + the date and time the alert was sent + date + + + type + One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29 + short + + + false + + + deployVirtualMachine + Creates and automatically starts a virtual machine based on a service offering, disk offering, and template. + true + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter + false + list + list + + + bootintosetup + Boot into hardware setup or not (ignored if startVm = false, only valid for vmware) + false + 4.15.0.0 + boolean + + + bootmode + Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + boottype + Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + clusterid + destination Cluster ID to deploy the VM to - parameter available for root admin only + false + 4.13 + uuid + + + copyimagetags + if true the image tags (if any) will be copied to the VM, default value is false + false + 4.13 + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter + false + map + 4.11 + map + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + details + used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details + false + map + 4.3 + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + diskofferingid + the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created. + false + uuid + + + displayname + an optional user generated name for the virtual machine + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + 4.2 + boolean + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain. + false + uuid + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable + false + 4.16 + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + an optional group for the virtual machine + false + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + uuid + + + hypervisor + the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call + false + string + + + iodriverpolicy + Controls specific policies on IO + false + string + + + iothreadsenabled + IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs. + false + boolean + + + ip6address + the ipv6 address for default vm's network + false + string + + + ipaddress + the ip address for default vm's network + false + string + + + iptonetworklist + ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid + false + map + map + + + keyboard + an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us + false + string + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs used to login to the virtual machine + false + list + 4.17 + list + + + macaddress + the mac address for default vm's network + false + string + + + name + host name for the virtual machine + false + string + + + networkids + list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter + false + list + list + + + nicmultiqueuenumber + The number of queues for multiqueue NICs. + false + 4.18 + integer + + + nicnetworklist + VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid + false + map + 4.15 + map + + + nicpackedvirtqueuesenabled + Enable packed virtqueues or not. + false + 4.18 + boolean + + + overridediskofferingid + the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id + false + 4.17 + uuid + + + password + The password of the virtual machine. If null, a random password will be generated for the VM. + false + 4.19.0.0 + string + + + podid + destination Pod ID to deploy the VM to - parameter available for root admin only + false + 4.13 + uuid + + + projectid + Deploy vm for the project + false + uuid + + + properties + used to specify the vApp properties. + false + map + 4.15 + map + + + rootdisksize + Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.4 + long + + + securitygroupids + comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + size + the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId + false + long + + + startvm + true if start vm after creating; defaulted to true if not specified + false + boolean + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the Userdata + false + 4.18 + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVolumes + Lists all volumes. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster id the disk volume belongs to + false + uuid + + + diskofferingid + list volumes by disk offering + false + 4.4 + uuid + + + displayvolume + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hostid + list volumes on specified host + false + uuid + + + id + the ID of the disk volume + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id + false + list + 4.9 + list + + + isencrypted + list only volumes that are encrypted + false + 4.19.1 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + listsystemvms + list system VMs; only ROOT admin is eligible to pass this parameter + false + 4.18 + boolean + + + name + the name of the disk volume + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod id the disk volume belongs to + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + serviceofferingid + list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored + false + 4.19.1 + uuid + + + state + state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged. + false + string + + + storageid + the ID of the storage pool, available to ROOT admin only + false + 4.3 + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + type + the type of disk volume + false + string + + + virtualmachineid + the ID of the virtual machine + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createLBHealthCheckPolicy + Creates a load balancer health check policy + true + 4.2.0 + + + lbruleid + the ID of the load balancer rule + true + uuid + + + description + the description of the load balancer health check policy + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + healthythreshold + Number of consecutive health check success before declaring an instance healthy + false + integer + + + intervaltime + Amount of time between health checks (1 sec - 20940 sec) + false + integer + + + pingpath + HTTP ping path + false + string + + + responsetimeout + Time to wait when receiving a response from the health check (2sec - 60 sec) + false + integer + + + unhealthythreshold + Number of consecutive health check failures before declaring an instance unhealthy + false + integer + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + lockUser + Locks a user account + false + + + id + Locks user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + cloudianIsEnabled + Checks if the Cloudian Connector is enabled + false + 4.11.0 + + + + enabled + the Cloudian connector enabled state + boolean + + + url + the Cloudian Management Console base URL + string + + + false + + + listNetworkOfferings + Lists all available network offerings. + false + + + availability + the availability of network offering. Default value is required + false + string + + + displaytext + list network offerings by display text + false + string + + + domainid + list network offerings available for network creation in specific domain + false + 4.13 + uuid + + + forvpc + the network offering can be used only for network creation inside the VPC + false + boolean + + + guestiptype + list network offerings by guest type: shared or isolated + false + string + + + id + list network offerings by ID + false + uuid + + + isdefault + true if need to list only default network offerings. Default value is false + false + boolean + + + istagged + true if offering has tags specified + false + boolean + + + keyword + List by keyword + false + string + + + name + list network offerings by name + false + string + + + networkid + the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to. + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + sourcenatsupported + true if need to list only netwok offerings where source NAT is supported, false otherwise + false + boolean + + + specifyipranges + true if need to list only network offerings which support specifying ip ranges + false + boolean + + + specifyvlan + the tags for the network offering. + false + boolean + + + state + list network offerings by state + false + string + + + supportedservices + list network offerings supporting certain services + false + list + list + + + tags + list network offerings by tags + false + string + + + traffictype + list by traffic type + false + string + + + zoneid + list network offerings available for network creation in specific zone + false + uuid + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + createNetwork + Creates a network + false + + + name + the name of the network + true + string + + + networkofferingid + the network offering ID + true + uuid + + + zoneid + the zone ID for the network + true + uuid + + + account + Account that will own the network. Account should be under the selected domain + false + string + + + aclid + Network ACL ID associated for the network + false + uuid + + + acltype + Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network + false + string + + + associatednetworkid + The network this network is associated to. only available if create a Shared network + false + 4.17.0 + uuid + + + bypassvlanoverlapcheck + when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks + false + boolean + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + false + boolean + + + displaytext + the display text of the network + false + string + + + dns1 + the first IPv4 DNS for the network + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the network + false + 4.18.0 + string + + + domainid + domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain. + false + uuid + + + endip + the ending IP address in the network IP range. If not specified, will be defaulted to startIP + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + externalid + ID of the network in an external system. + false + string + + + gateway + the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC + false + string + + + hideipaddressusage + when true ip address usage for the network will not be exported by the listUsageRecords API + false + boolean + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6dns1 + the first IPv6 DNS for the network + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + false + 4.18.0 + string + + + ip6gateway + the gateway of the IPv6 network. Required for Shared networks + false + string + + + isolatedpvlan + the isolated private VLAN for this network + false + string + + + isolatedpvlantype + the isolated private VLAN type for this network + false + string + + + netmask + the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC + false + string + + + networkdomain + network domain + false + string + + + physicalnetworkid + the physical network ID the network belongs to + false + uuid + + + privatemtu + MTU to be configured on the network VR's private interface(s) + false + 4.18.0 + integer + + + projectid + an optional project for the network + false + uuid + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + routerip + IPV4 address to be assigned to a router in a shared network + false + 4.16 + string + + + routeripv6 + IPV6 address to be assigned to a router in a shared network + false + 4.16 + string + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. +If an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented, + false + 4.19 + string + + + startip + the beginning IP address in the network IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + subdomainaccess + Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified + false + boolean + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + false + string + + + vlan + the ID or VID of the network + false + string + + + vpcid + the VPC network belongs to + false + uuid + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listDedicatedPods + Lists dedicated pods. + false + + + account + the name of the account associated with the pod. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated pods by affinity group + false + uuid + + + domainid + the ID of the domain associated with the pod + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the ID of the pod + false + uuid + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Pod is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the pod + string + + + domainid + the domain ID to which the Pod is dedicated + string + + + podid + the ID of the Pod + string + + + podname + the Name of the Pod + string + + + false + + + listVPCs + Lists VPCs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + cidr + list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR + false + string + + + displaytext + List by display text of the VPC + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + list VPC by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list by name of the VPC + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + restartrequired + list VPCs by restartRequired option + false + boolean + + + showicon + flag to display the resource icon for VPCs + false + boolean + + + state + list VPCs by state + false + string + + + supportedservices + list VPC supporting certain services + false + list + list + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vpcofferingid + list by ID of the VPC offering + false + uuid + + + zoneid + list by zone + false + uuid + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + runDiagnostics + Execute network-utility command (ping/arping/tracert) on system VMs remotely + true + 4.12.0.0 + + + ipaddress + The IP/Domain address to test connection to + true + string + + + targetid + The ID of the system VM instance to diagnose + true + uuid + + + type + The system VM diagnostics type valid options are: ping, traceroute, arping + true + string + + + params + Additional command line options that apply for each command + false + string + + + + + exitcode + the command execution return code + string + + + stderr + the standard error output from the command execution + string + + + stdout + the standard output from the command execution + string + + + false + + + addNetworkDevice + Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer + false + + + networkdeviceparameterlist + parameters for network device + false + map + map + + + networkdevicetype + Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall + false + string + + + + + id + the ID of the network device + string + + + false + + + restartVPC + Restarts a VPC + true + + + id + the id of the VPC + true + uuid + + + cleanup + If cleanup old network elements + false + boolean + + + livepatch + Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false. + false + 4.17.0 + boolean + + + makeredundant + Turn a single VPC into a redundant one. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addBaremetalDhcp + adds a baremetal dhcp server + true + + + dhcpservertype + Type of dhcp device + true + string + + + password + Credentials to reach external dhcp device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the external dhcp appliance. + true + string + + + username + Credentials to reach external dhcp device + true + string + + + + + id + device id of + string + + + dhcpservertype + name of the provider + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + deleteTungstenFabricApplicationPolicySet + delete Tungsten-Fabric application policy set + true + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + copySnapshot + Copies a snapshot from one zone to another. + true + 4.19.0 + + + id + the ID of the snapshot. + true + uuid + + + destzoneid + The ID of the zone the snapshot is being copied to. + false + uuid + + + destzoneids + A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required. + false + list + list + + + sourcezoneid + The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used. + false + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addTrafficMonitor + Adds Traffic Monitor Host for Direct Network Usage + false + + + url + URL of the traffic monitor Host + true + string + + + zoneid + Zone in which to add the external firewall appliance. + true + uuid + + + excludezones + Traffic going into the listed zones will not be metered + false + string + + + includezones + Traffic going into the listed zones will be metered + false + string + + + + + id + the ID of the external firewall + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + listUsers + Lists user accounts + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accounttype + List users by account type. Valid types include admin, domain-admin, read-only-admin, or user. + false + integer + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + List user by ID. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for users + false + boolean + + + state + List users by state of the user account. + false + string + + + username + List user by the username + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + updateVlanIpRange + Updates a VLAN IP range. + false + 4.16.0 + + + id + the UUID of the VLAN IP range + true + uuid + + + endip + the ending IP address in the VLAN IP range + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + forsystemvms + true if IP range is set to system vms, false if not + false + boolean + + + gateway + the gateway of the VLAN IP range + false + string + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6gateway + the gateway of the IPv6 network + false + string + + + netmask + the netmask of the VLAN IP range + false + string + + + startip + the beginning IP address in the VLAN IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + listResourceLimits + Lists resource limits. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + Lists resource limits by ID. + false + long + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourcetype + Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + integer + + + resourcetypename + Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + string + + + + + account + the account of the resource limit + string + + + domain + the domain name of the resource limit + string + + + domainid + the domain ID of the resource limit + string + + + domainpath + path of the domain to which the resource limit belongs + 4.19.2.0 + string + + + max + the maximum number of the resource. A -1 means the resource currently has no limit. + long + + + project + the project name of the resource limit + string + + + projectid + the project id of the resource limit + string + + + resourcetype + 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. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + false + + + disableUser + Disables a user account + true + + + id + Disables user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + listIsos + Lists all available ISO files. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + bootable + true if the ISO is bootable, false otherwise + false + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + list ISO by ID + false + uuid + + + imagestoreid + ID of the image or image cache store + false + 4.19 + uuid + + + isofilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + false + string + + + ispublic + true if the ISO is publicly available to all users, false otherwise. + false + boolean + + + isready + true if this ISO is ready to be deployed + false + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list all ISOs by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the isos + false + boolean + + + showremoved + show removed ISOs as well + false + boolean + + + showunique + If set to true, list only unique isos across zones + false + 4.13.2 + boolean + + + storageid + ID of the storage pool + false + 4.19 + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + zoneid + the ID of the zone + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listAutoScalePolicies + Lists autoscale policies. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + false + string + + + conditionid + the ID of the condition of the policy + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the autoscale policy + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vmgroupid + the ID of the autoscale vm group + false + uuid + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + domainpath + path of the domain to which the autoscale policy belongs + 4.19.2.0 + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + addBaremetalRct + adds baremetal rack configuration text + true + + + baremetalrcturl + http url to baremetal RCT configuration + true + object + + + + + id + id of rct + string + + + url + url + string + + + false + + + updateRole + Updates a role + false + 4.9.0 + + + id + ID of the role + true + uuid + + + description + The description of the role + false + string + + + description + The description of the role + false + string + + + ispublic + Indicates whether the role will be visible to all users (public) or only to root admins (private). + false + boolean + + + name + creates a role with this unique name + false + string + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + listRemoteAccessVpns + Lists remote access vpns + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists remote access vpn rule with the specified ID + false + 4.3 + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list remote access VPNs for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + publicipid + public ip address id of the vpn server + false + uuid + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + deleteNetworkACLList + Deletes a network ACL + true + + + id + the ID of the network ACL + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createServiceInstance + Creates a system virtual-machine that implements network services + true + + + leftnetworkid + The left (inside) network for service instance + true + uuid + + + name + The name of the service instance + true + string + + + rightnetworkid + The right (outside) network ID for the service instance + true + uuid + + + serviceofferingid + The service offering ID that defines the resources consumed by the service appliance + true + uuid + + + templateid + The template ID that specifies the image for the service appliance + true + uuid + + + zoneid + Availability zone for the service instance + true + uuid + + + account + An optional account for the virtual machine. Must be used with domainId. + false + string + + + domainid + An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + Project ID for the service instance + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the Domain in which the virtual machine exists + 4.19.2.0 + string + + + name + the name of the virtual machine + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + false + + + removeIpFromNic + Removes secondary IP from the NIC. + true + + + id + the ID of the secondary ip address to nic + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + startSystemVm + Starts a system virtual machine. + true + + + id + The ID of the system virtual machine + true + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + registerVnfTemplate + Registers an existing VNF template into the CloudStack cloud. + false + 4.19.0 + + + format + the format for the template. Possible values include QCOW2, RAW, VHD and OVA. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the template + true + string + + + url + the URL of where the template is hosted. Possible URL include http:// and https:// + true + string + + + account + an optional accountName. Must be used with domainId. + false + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + directdownload + true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + displaytext + The display text of the template, defaults to 'name'. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Register template for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + 4.19.0 + string + + + vnfdetails + VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0 + false + map + map + + + vnfnics + VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC + false + map + map + + + zoneid + the ID of the zone the template is to be hosted on + false + uuid + + + zoneids + A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. + false + list + list + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVirtualMachinesUsageHistory + Lists VM stats + false + 4.17 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the virtual machine. + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + name + the name of the virtual machine + string + + + stats + the list of VM stats + list + + + false + + + declareHostAsDegraded + Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host. + true + 4.16.0.0 + + + id + host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createKubernetesCluster + Creates a Kubernetes cluster + true + + + name + name for the Kubernetes cluster + true + string + + + zoneid + availability zone in which Kubernetes cluster to be launched + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged. + false + 4.19.0 + string + + + controlnodes + number of Kubernetes cluster control nodes, default is 1 + false + long + + + description + description for the Kubernetes cluster + false + string + + + dockerregistrypassword + password for the docker image private registry + false + string + + + dockerregistryurl + URL for the docker image private registry + false + string + + + dockerregistryusername + user name for the docker image private registry + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + externalloadbalanceripaddress + external load balancer IP address while using shared network with Kubernetes HA cluster + false + string + + + keypair + name of the ssh key pair used to login to the virtual machines + false + string + + + kubernetesversionid + Kubernetes version with which cluster to be launched + false + uuid + + + masternodes + number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter. + false + long + + + networkid + Network in which Kubernetes cluster is to be launched + false + uuid + + + noderootdisksize + root disk size in GB for each node + false + long + + + projectid + Deploy cluster for the project + false + uuid + + + serviceofferingid + the ID of the service offering for the virtual machines in the cluster. + false + uuid + + + size + number of Kubernetes cluster worker nodes + false + long + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + listStorageNetworkIpRange + List a storage network IP range. + false + 3.0.0 + + + id + optional parameter. Storaget network IP range uuid, if specicied, using it to search the range. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range. + false + uuid + + + zoneid + optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range. + false + uuid + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + configureVirtualRouterElement + Configures a virtual router element. + true + + + id + the ID of the virtual router provider + true + uuid + + + enabled + Enabled/Disabled the service provider + true + boolean + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + enableHAForHost + Enables HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + registerNetscalerServicePackage + Registers NCC Service Package + false + + + description + Description of Service Package + true + string + + + name + Name of the service Package. + true + string + + + + + id + Service Package UUID + string + + + description + Description of Service Package + string + + + name + Service Package Name + string + + + false + + + updateVMAffinityGroup + Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. + true + + + id + The ID of the virtual machine + true + uuid + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + quotaCredits + Add +-credits to an account + false + 4.7.0 + + + account + Account Id for which quota credits need to be added + true + string + + + domainid + Domain for which quota credits need to be added + true + uuid + + + value + Value of the credits to be added+, subtracted- + true + double + + + min_balance + Minimum balance threshold of the account + false + double + + + quota_enforce + Account for which quota enforce is set to false will not be locked when there is no credit balance + false + boolean + + + + + credits + the credit deposited + bigdecimal + + + currency + currency + string + + + updated_by + the user name of the admin who updated the credits + string + + + updated_on + the account name of the admin who updated the credits + date + + + false + + + listCaCertificate + Lists the CA public certificate(s) as support by the configured/provided CA plugin + false + 4.11.0 + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + cacertificates + The CA certificate(s) + string + + + certificate + The client certificate + string + + + privatekey + Private key for the certificate + string + + + false + + + provisionTemplateDirectDownloadCertificate + Provisions a host with a direct download certificate + false + 4.17.0 + + + id + the id of the direct download certificate to provision + true + uuid + + + hostid + the host to provision the certificate + true + uuid + + + + + details + indicates the details in case of failure or host skipped + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + status + indicates if the certificate has been revoked from the host, failed or skipped + string + + + false + + + samlSlo + SAML Global Log Out API + false + + + + description + Response description + string + + + false + + + updateProjectRole + Creates a Project role + false + 4.15.0 + + + id + ID of the Project role + true + uuid + + + projectid + ID of project where role is being created + true + uuid + + + description + The description of the Project role + false + string + + + name + creates a project role with this unique name + false + string + + + + + projectid + the id of the project + string + + + false + + + addLdapConfiguration + Add a new Ldap Configuration + false + 4.2.0 + + + hostname + Hostname + true + string + + + port + Port + true + integer + + + domainid + linked domain + false + uuid + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port the ldap server is running on + int + + + false + + + createTungstenFabricAddressGroup + create Tungsten-Fabric address group + true + + + ipprefix + Tungsten-Fabric ip prefix + true + string + + + ipprefixlen + Tungsten-Fabric ip prefix length + true + integer + + + name + Tungsten-Fabric address group name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + ipprefix + Tungsten-Fabric address group ip prefix + string + + + ipprefixlen + Tungsten-Fabric address group ip prefix length + int + + + name + Tungsten-Fabric address group name + string + + + uuid + Tungsten-Fabric address group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listBigSwitchBcfDevices + Lists BigSwitch BCF Controller devices + false + 4.6.0 + + + bcfdeviceid + bigswitch BCF controller device ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + bcfdeviceid + device id of the BigSwitch BCF Controller + string + + + bigswitchdevicename + device name + string + + + hostname + the controller Ip address + string + + + nat + NAT support + boolean + + + password + the controller password + string + + + physicalnetworkid + the physical network to which this BigSwitch BCF segment belongs to + string + + + provider + name of the provider + string + + + username + the controller username + string + + + false + + + listRegisteredServicePackages + lists registered service packages + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + Service Package UUID + string + + + description + Description of Service Package + string + + + name + Service Package Name + string + + + false + + + enableStaticNat + Enables static NAT for given IP address + false + + + ipaddressid + the public IP address ID for which static NAT feature is being enabled + true + uuid + + + virtualmachineid + the ID of the virtual machine for enabling static NAT feature + true + uuid + + + networkid + The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case) + false + uuid + + + vmguestip + VM guest NIC secondary IP address for the port forwarding rule + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteZone + Deletes a Zone. + false + + + id + the ID of the Zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getUploadParamsForTemplate + upload an existing template into the CloudStack cloud. + false + 4.6.0 + + + format + the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the volume/template/iso + true + string + + + zoneid + the ID of the zone the volume/template/iso is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs. + false + map + map + + + displaytext + the display text of the template. This is usually used for display purposes. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file. + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Upload volume/template/iso for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + deleteSnapshotPolicies + Deletes snapshot policies for the account. + false + + + id + the Id of the snapshot policy + false + uuid + + + ids + list of snapshots policy IDs separated by comma + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTrafficTypeImplementors + Lists implementors of implementor of a network traffic type or implementors of all network traffic types + false + 3.0.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + traffictype + Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor + false + string + + + + + traffictype + network traffic type + string + + + traffictypeimplementor + implementor of network traffic type + string + + + false + + + listDbMetrics + list the db hosts and statistics + false + 4.17.0 + + + + collectiontime + the time these statistics were collected + date + + + connections + the number of connections to the DB + int + + + dbloadaverages + the last measured load averages on the DB + double[] + + + hostname + the name of the active usage server + string + + + queries + the number of queries performed on the DB + long + + + replicas + the state of the usage server + string[] + + + tlsversions + the tls versions currently in use (accepted) by the DB + string + + + uptime + the uptime of the DB in seconds + long + + + version + the version of the currently running DB + string + + + versioncomment + the version of the currently running DB + string + + + false + + + deleteImageStore + Deletes an image store or Secondary Storage. + false + 4.2.0 + + + id + The image store ID or Secondary Storage ID. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAutoScaleVmProfiles + Lists autoscale vm profiles. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the autoscale vm profile + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + otherdeployparams + the otherdeployparameters of the autoscale vm profile + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + serviceofferingid + list profiles by service offering id + false + 4.4 + uuid + + + templateid + the templateid of the autoscale vm profile + false + uuid + + + zoneid + availability zone for the auto deployed virtual machine + false + 4.4 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + domainpath + path of the domain to which the vm profile belongs + 4.19.2.0 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base64 encoded VM user data + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.1 + string + + + userdataid + the id of userdata used for the VM + 4.18.1 + string + + + userdataname + the name of userdata used for the VM + 4.18.1 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.1 + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + authorizeSecurityGroupIngress + Authorizes a particular ingress rule for this security group + true + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + cidrlist + the cidr list associated. Multiple entries must be separated by a single comma character (,). + false + list + list + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + endport + end port for this ingress rule + false + integer + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + projectid + an optional project of the security group + false + uuid + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default. + false + string + + + securitygroupid + The ID of the security group. Mutually exclusive with securityGroupName parameter + false + uuid + + + securitygroupname + The name of the security group. Mutually exclusive with securityGroupId parameter + false + string + + + startport + start port for this ingress rule + false + integer + + + usersecuritygrouplist + user to security group mapping + false + map + map + + + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + syncStoragePool + Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it) + true + 4.15.1 + + + id + Storage pool id + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateBucket + Updates Bucket properties + false + 4.19.0 + + + id + The ID of the Bucket + true + uuid + + + encryption + Enable/Disable Bucket encryption + false + boolean + + + policy + Bucket Access Policy + false + string + + + quota + Bucket Quota in GB + false + integer + + + versioning + Enable/Disable Bucket Versioning + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateResourceCount + Recalculate and update resource count for an account or domain. + false + + + domainid + If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain. + true + uuid + + + account + Update resource count for a specified account. Must be used with the domainId parameter. + false + string + + + projectid + Update resource limits for project + false + uuid + + + resourcetype + Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + integer + + + + + account + the account for which resource count's are updated + string + + + domain + the domain name for which resource count's are updated + string + + + domainid + the domain ID for which resource count's are updated + string + + + domainpath + path of the domain to which the resource counts are updated + 4.19.2.0 + string + + + project + the project name for which resource count's are updated + string + + + projectid + the project id for which resource count's are updated + string + + + resourcecount + resource count + long + + + resourcetype + resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + false + + + listRoles + Lists dynamic roles in CloudStack + false + 4.9.0 + + + id + List role by role ID. + false + uuid + + + keyword + List by keyword + false + string + + + name + List role by role name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + type + List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User. + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + type + the type of the role + string + + + false + + + listTungstenFabricPolicy + list Tungsten-Fabric policy + false + + + ipaddressid + the ID of ip address + false + uuid + + + keyword + List by keyword + false + string + + + networkid + the ID of network + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + downloadImageStoreObject + Download object at a specified path on an image store. + true + 4.19.0 + + + id + id of the image store + true + uuid + + + path + path to download on image store + false + string + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + getCloudIdentifier + Retrieves a cloud identifier. + false + + + userid + the user ID for the cloud identifier + true + uuid + + + + + cloudidentifier + the cloud identifier + string + + + signature + the signed response for the cloud identifier + string + + + userid + the user ID for the cloud identifier + string + + + false + + + createLBStickinessPolicy + Creates a load balancer stickiness policy + true + 3.0.0 + + + lbruleid + the ID of the load balancer rule + true + uuid + + + methodname + name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased + true + string + + + name + name of the load balancer stickiness policy + true + string + + + description + the description of the load balancer stickiness policy + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + param + param list. Example: param[0].name=cookiename&param[0].value=LBCookie + false + map + map + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + addCiscoAsa1000vResource + Adds a Cisco Asa 1000v appliance + false + + + clusterid + the Cluster ID + true + uuid + + + hostname + Hostname or ip address of the Cisco ASA 1000v appliance. + true + string + + + insideportprofile + Nexus port profile associated with inside interface of ASA 1000v + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + + false + + + configurePaloAltoFirewall + Configures a Palo Alto firewall device + true + + + fwdeviceid + Palo Alto firewall device ID + true + uuid + + + fwdevicecapacity + capacity of the firewall device, Capacity will be interpreted as number of networks device can handle + false + long + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + updateNetworkACLItem + Updates ACL item with specified ID + true + + + id + the ID of the network ACL item + true + uuid + + + action + scl entry action, allow or deny + false + string + + + cidrlist + the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + endport + the ending port of ACL + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + number + The network of the vm the ACL will be created for + false + integer + + + partialupgrade + Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'. + false + boolean + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + false + string + + + reason + A description indicating why the ACL rule is required. + false + string + + + startport + the starting port of ACL + false + integer + + + traffictype + the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listRouters + List routers. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster ID of the router + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fetchhealthcheckresults + if true is passed for this parameter, also fetch last executed health check results for the router. Default is false + false + 4.14 + boolean + + + forvpc + if true is passed for this parameter, list only VPC routers + false + boolean + + + healthchecksfailed + if this parameter is passed, list only routers by health check results + false + 4.16 + boolean + + + hostid + the host ID of the router + false + uuid + + + id + the ID of the disk router + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the router + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the router + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + the state of the router + false + string + + + version + list virtual router elements by version + false + string + + + vpcid + List networks by VPC + false + uuid + + + zoneid + the Zone ID of the router + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listTungstenFabricVm + list Tungsten-Fabric vm + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + vmuuid + the uuid of Tungsten-Fabric vm + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric vm name + string + + + uuid + Tungsten-Fabric nic uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + deletePhysicalNetwork + Deletes a Physical Network. + true + 3.0.0 + + + id + the ID of the Physical network + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addTungstenFabricPolicyRule + add Tungsten-Fabric policy rule + true + + + action + Tungsten-Fabric policy rule action + true + string + + + destendport + Tungsten-Fabric policy rule destination end port + true + integer + + + destipprefix + Tungsten-Fabric policy rule destination ip prefix + true + string + + + destipprefixlen + Tungsten-Fabric policy rule destination ip prefix length + true + integer + + + destnetwork + Tungsten-Fabric policy rule destination network + true + string + + + deststartport + Tungsten-Fabric policy rule destination start port + true + integer + + + direction + Tungsten-Fabric policy rule direction + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + protocol + Tungsten-Fabric policy rule protocol + true + string + + + srcendport + Tungsten-Fabric policy rule source end port + true + integer + + + srcipprefix + Tungsten-Fabric policy rule source ip prefix + true + string + + + srcipprefixlen + Tungsten-Fabric policy rule source ip prefix length + true + integer + + + srcnetwork + Tungsten-Fabric policy rule source network + true + string + + + srcstartport + Tungsten-Fabric policy rule source start port + true + integer + + + zoneid + the ID of zone + true + uuid + + + + + action + Tungsten-Fabric policy action + string + + + destendport + Tungsten-Fabric policy destination end port + int + + + destipprefix + Tungsten-Fabric policy destination ip prefix + string + + + destipprefixlen + Tungsten-Fabric policy destination ip prefix length + int + + + destnetwork + Tungsten-Fabric policy destination network + string + + + deststartport + Tungsten-Fabric policy destination start port + int + + + direction + Tungsten-Fabric policy name + string + + + policyuuid + Tungsten-Fabric policy uuid + string + + + protocol + Tungsten-Fabric policy protocol + string + + + srcendport + Tungsten-Fabric policy source end port + int + + + srcipprefix + Tungsten-Fabric policy source ip prefix + string + + + srcipprefixlen + Tungsten-Fabric policy source ip prefix length + int + + + srcnetwork + Tungsten-Fabric policy source network + string + + + srcstartport + Tungsten-Fabric policy source start port + int + + + uuid + Tungsten-Fabric rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + removeVpnUser + Removes vpn user + true + + + username + username for the vpn user + true + string + + + account + an optional account for the vpn user. Must be used with domainId. + false + string + + + domainid + an optional domainId for the vpn user. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + remove vpn user from the project + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listQuarantinedIps + List public IP addresses in quarantine. + false + 4.19 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + showinactive + Show IPs that are no longer in quarantine. + false + boolean + + + showremoved + Show IPs removed from quarantine. + false + boolean + + + + + id + ID of the quarantine process. + string + + + created + When the quarantine was created. + date + + + enddate + End date for the quarantine. + date + + + ipaddress + The public IP address in quarantine. + string + + + previousownerid + Account ID of the previous public IP address owner. + string + + + previousownername + Account name of the previous public IP address owner. + string + + + removalreason + The reason for removing the IP from quarantine prematurely. + string + + + removed + When the quarantine was removed. + date + + + removeraccountid + ID of the account that removed the IP from quarantine. + string + + + false + + + deleteLBHealthCheckPolicy + Deletes a load balancer health check policy. + true + 4.2.0 + + + id + the ID of the load balancer health check policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableHAForHost + Disables HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + listSwifts + List Swift. + false + 3.0.0 + + + id + the id of the swift + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + enableOutOfBandManagementForHost + Enables out-of-band management for a host + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listKubernetesSupportedVersions + Lists supported Kubernetes version + false + + + id + the ID of the Kubernetes supported version + false + uuid + + + keyword + List by keyword + false + string + + + minimumkubernetesversionid + the ID of the minimum Kubernetes supported version + false + uuid + + + minimumsemanticversion + the minimum semantic version for the Kubernetes supported version to be listed + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of the zone in which Kubernetes supported version will be available + false + uuid + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + directdownload + KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage + 4.18.2 + boolean + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + deleteServiceOffering + Deletes a service offering. + false + + + id + the ID of the service offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addNiciraNvpDevice + Adds a Nicira NVP device + true + + + hostname + Hostname of ip address of the Nicira NVP Controller. + true + string + + + password + Credentials to access the Nicira Controller API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + transportzoneuuid + The Transportzone UUID configured on the Nicira Controller + true + string + + + username + Credentials to access the Nicira Controller API + true + string + + + l2gatewayserviceuuid + The L2 Gateway Service UUID configured on the Nicira Controller + false + string + + + l3gatewayserviceuuid + The L3 Gateway Service UUID configured on the Nicira Controller + false + string + + + + + hostname + the controller Ip address + string + + + l2gatewayserviceuuid + this L2 gateway service Uuid + string + + + l3gatewayserviceuuid + this L3 gateway service Uuid + string + + + niciradevicename + device name + string + + + nvpdeviceid + device id of the Nicire Nvp + string + + + physicalnetworkid + the physical network to which this Nirica Nvp belongs to + string + + + provider + name of the provider + string + + + transportzoneuuid + the transport zone Uuid + string + + + false + + + listInfrastructure + Lists infrastructure + false + 4.9.3 + + + + alerts + Number of Alerts + integer + + + clusters + Number of clusters + integer + + + cpusockets + Number of cpu sockets + integer + + + hosts + Number of hypervisor hosts + integer + + + ilbvms + Number of internal LBs + integer + + + imagestores + Number of images stores + integer + + + managementservers + Number of management servers + integer + + + objectstores + Number of object stores + integer + + + pods + Number of pods + integer + + + routers + Number of routers + integer + + + storagepools + Number of storage pools + integer + + + systemvms + Number of systemvms + integer + + + zones + Number of zones + integer + + + false + + + listUsageRecords + Lists usage records for accounts + false + + + enddate + End date range for usage record query (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00). + true + date + + + startdate + Start date range for usage record query (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00). + true + date + + + account + List usage records for the specified user. + false + string + + + accountid + List usage records for the specified account + false + uuid + + + domainid + List usage records for the specified domain. + false + uuid + + + includetags + Flag to enable display of Tags for a resource + false + boolean + + + isrecursive + Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account. + false + 4.15 + boolean + + + keyword + List by keyword + false + string + + + oldformat + Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + List usage records for specified project + false + uuid + + + type + List usage records for the specified usage type + false + long + + + usageid + List usage records for the specified usage UUID. Can be used only together with TYPE parameter. + false + string + + + + + account + the user account name + string + + + accountid + the user account Id + string + + + cpunumber + number of cpu of resource + long + + + cpuspeed + speed of each cpu of resource + long + + + description + description of the usage record + string + + + domain + the domain the resource is associated with + string + + + domainid + the domain ID + string + + + domainpath + path of the domain to which the usage reocrd belongs + 4.19.2.0 + string + + + enddate + end date of the usage record + string + + + isdefault + True if the resource is default + boolean + + + issourcenat + True if the IPAddress is source NAT + boolean + + + issystem + True if the IPAddress is system IP - allocated during vm deploy or lb rule create + boolean + + + memory + memory allocated for the resource + long + + + name + resource or virtual machine name + string + + + networkid + id of the network + string + + + offeringid + offering ID + string + + + oscategoryid + virtual machine guest os category ID + string + + + oscategoryname + virtual machine os category name + string + + + osdisplayname + virtual machine os display name + string + + + ostypeid + virtual machine os type ID + string + + + project + the project name of the resource + string + + + projectid + the project id of the resource + string + + + rawusage + raw usage in hours + string + + + size + resource size + long + + + startdate + start date of the usage record + string + + + templateid + template ID + string + + + type + resource type + string + + + usage + usage in hours + string + + + usageid + id of the resource + string + + + usagetype + usage type ID + integer + + + virtualmachineid + virtual machine ID + string + + + virtualsize + virtual size of resource + long + + + vpcid + id of the vpc + string + + + zoneid + the zone ID + string + + + false + + + recoverVolume + Recovers a Destroy volume. + false + 4.14.0 + + + id + The ID of the volume + true + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeTungstenFabricNetworkGatewayFromLogicalRouter + remove Tungsten-Fabric network gateway from logical router + true + + + logicalrouteruuid + Tungsten-Fabric logical router uuid + true + string + + + networkuuid + Tungsten-Fabric network uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listVolumesForImport + Lists unmanaged volumes on a storage pool + false + 4.19.1 + + + storageid + the ID of the storage pool + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the path of the volume on the storage pool + false + string + + + + + chaininfo + the chain info of the volume + string + + + details + volume details in key/value pairs. + map + + + encryptformat + the encrypt format of the volume + string + + + format + the format of the volume + string + + + fullpath + the full path of the volume + string + + + name + the name of the volume + string + + + path + the path of the volume + string + + + size + the size of the volume + long + + + storage + name of the primary storage hosting the volume + string + + + storageid + id of the primary storage hosting the volume + string + + + storagetype + type of the primary storage hosting the volume + string + + + virtualsize + the virtual size of the volume + long + + + false + + + listZonesMetrics + Lists zone metrics + false + 4.9.3 + + + available + true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false. + false + boolean + + + domainid + the ID of the domain associated with the zone + false + uuid + + + id + the ID of the zone + false + uuid + + + ids + the IDs of the zones, mutually exclusive with id + false + list + 4.19.0 + list + + + keyword + List by keyword + false + string + + + name + the name of the zone + false + string + + + networktype + the network type of the zone that the virtual machine belongs to + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the zones + false + boolean + + + showicon + flag to display the resource image for the zones + false + boolean + + + tags + List zones by resource tags (key/value pairs) + false + map + 4.3 + map + + + + + clusters + healthy / total clusters in the zone + string + + + cpuallocated + the total cpu allocated in Ghz + string + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpumaxdeviation + the maximum cpu deviation + string + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotal + the total cpu capacity in Ghz + string + + + cpuused + the total cpu used in Ghz + string + + + memoryallocated + the total cpu allocated in GiB + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorymaxdeviation + the maximum memory deviation + string + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotal + the total cpu capacity in GiB + string + + + memoryused + the total cpu used in GiB + string + + + state + state of the cluster + string + + + false + + + extractTemplate + Extracts a template + true + + + id + the ID of the template + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + url + the url to which the ISO would be extracted + false + string + + + zoneid + the ID of the zone where the ISO is originally located + false + uuid + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + expungeVirtualMachine + Expunge a virtual machine. Once expunged, it cannot be recoverd. + true + + + id + The ID of the virtual machine + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateIpAddress + Updates an IP address + true + + + id + the ID of the public IP address to update + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + 4.4 + boolean + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + migrateNetwork + moves a network to another physical network + true + 4.11.0 + + + networkid + the ID of the network + true + uuid + + + networkofferingid + network offering ID + true + uuid + + + resume + true if previous network migration cmd failed + false + boolean + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The routing mode of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listUnmanagedInstances + Lists unmanaged virtual machines for a given cluster. + false + 4.14.0 + + + clusterid + the cluster ID + true + uuid + + + keyword + List by keyword + false + string + + + name + the hypervisor name of the instance + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + clusterid + the ID of the cluster to which virtual machine belongs + string + + + clustername + the name of the cluster to which virtual machine belongs + string + + + cpucorepersocket + the CPU cores per socket for the virtual machine. VMware specific + integer + + + cpunumber + the CPU cores of the virtual machine + integer + + + cpuspeed + the CPU speed of the virtual machine + integer + + + hostid + the ID of the host to which virtual machine belongs + string + + + hostname + the name of the host to which virtual machine belongs + string + + + memory + the memory of the virtual machine in MB + integer + + + name + the name of the virtual machine + string + + + osdisplayname + the operating system of the virtual machine + string + + + osid + the operating system ID of the virtual machine + string + + + powerstate + the power state of the virtual machine + string + + + disk(*) + the list of disks associated with the virtual machine + + + id + the ID of the disk + string + + + capacity + the capacity of the disk in bytes + long + + + controller + the controller of the disk + string + + + controllerunit + the controller unit of the disk + integer + + + datastorehost + the controller of the disk + string + + + datastorename + the controller of the disk + string + + + datastorepath + the controller of the disk + string + + + datastoretype + the controller of the disk + string + + + imagepath + the file path of the disk image + string + + + label + the label of the disk + string + + + position + the position of the disk + integer + + + set + + + nic(*) + the list of nics associated with the virtual machine + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + registerTemplate + Registers an existing template into the CloudStack cloud. + false + + + format + the format for the template. Possible values include QCOW2, RAW, VHD and OVA. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the template + true + string + + + url + the URL of where the template is hosted. Possible URL include http:// and https:// + true + string + + + account + an optional accountName. Must be used with domainId. + false + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + directdownload + true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + displaytext + The display text of the template, defaults to 'name'. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Register template for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + 4.19.0 + string + + + zoneid + the ID of the zone the template is to be hosted on + false + uuid + + + zoneids + A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. + false + list + list + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addStratosphereSsp + Adds stratosphere ssp server + false + + + name + stratosphere ssp api name + true + string + + + url + stratosphere ssp server url + true + string + + + zoneid + the zone ID + true + uuid + + + password + stratosphere ssp api password + false + string + + + tenantuuid + stratosphere ssp tenant uuid + false + string + + + username + stratosphere ssp api username + false + string + + + + + hostid + server id of the stratosphere ssp server + string + + + name + name + string + + + url + url of ssp endpoint + string + + + zoneid + zone which this ssp controls + string + + + false + + + listVnfAppliances + List VNF appliance owned by the account. + false + 4.19.1 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + details + comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. + false + 4.19.0 + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + findStoragePoolsForMigration + Lists storage pools available for migration of a volume. + false + + + id + the ID of the volume + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createStoragePool + Creates a storage pool. + false + + + name + the name for the storage pool + true + string + + + url + the URL of the storage pool + true + string + + + zoneid + the Zone ID for the storage pool + true + uuid + + + capacitybytes + bytes CloudStack can provision from this storage pool + false + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + false + long + + + clusterid + the cluster ID for the storage pool + false + uuid + + + details + the details for the storage pool + false + map + map + + + hypervisor + hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now. + false + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + false + boolean + + + managed + whether the storage should be managed by CloudStack + false + boolean + + + podid + the Pod ID for the storage pool + false + uuid + + + provider + the storage provider name + false + string + + + scope + the scope of the storage: cluster or zone + false + string + + + tags + the tags for the storage pool + false + string + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteTungstenFabricFirewallRule + delete Tungsten-Fabric firewall rule + true + + + firewallruleuuid + the uuid of Tungsten-Fabric firewall rule + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableCiscoNexusVSM + disable a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be deleted + true + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + createStorageNetworkIpRange + Creates a Storage network IP range. + true + 3.0.0 + + + gateway + the gateway for storage network + true + string + + + netmask + the netmask for storage network + true + string + + + podid + UUID of pod where the ip range belongs to + true + uuid + + + startip + the beginning IP address + true + string + + + endip + the ending IP address + false + string + + + vlan + Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table + false + integer + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + configureOvsElement + Configures an ovs element. + true + + + id + the ID of the ovs provider + true + uuid + + + enabled + Enabled/Disabled the service provider + true + boolean + + + + + id + the id of the ovs + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + listSystemVmsUsageHistory + Lists System VM stats + false + 4.18.0 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the system VM. + false + uuid + + + ids + the IDs of the system VMs, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + name + the name of the virtual machine + string + + + stats + the list of VM stats + list + + + false + + + deleteIpv6FirewallRule + Deletes a IPv6 firewall rule + true + + + id + the ID of the IPv6 firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVolume + Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it. + true + + + account + the account associated with the disk volume. Must be used with the domainId parameter. + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + diskofferingid + the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in. + false + uuid + + + displayvolume + an optional field, whether to display the volume to the end user or not. + false + boolean + + + domainid + the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain. + false + uuid + + + maxiops + max iops + false + long + + + miniops + min iops + false + long + + + name + the name of the disk volume + false + string + + + projectid + the project associated with the volume. Mutually exclusive with account parameter + false + uuid + + + size + Arbitrary volume size + false + long + + + snapshotid + the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in. + false + uuid + + + virtualmachineid + the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes allocated + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes actually consumed on disk + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createFirewallRule + Creates a firewall rule for a given IP address + true + + + ipaddressid + the IP address id of the port forwarding rule + true + uuid + + + protocol + the protocol for the firewall rule. Valid values are TCP/UDP/ICMP. + true + string + + + cidrlist + the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + startport + the starting port of firewall rule + false + integer + + + type + type of firewallrule: system/user + false + string + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listVMSnapshot + List virtual machine snapshot by conditions + false + 4.2.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + lists snapshot by snapshot name or display name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + state of the virtual machine snapshot + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + the ID of the vm + false + uuid + + + vmsnapshotid + The ID of the VM snapshot + false + uuid + + + vmsnapshotids + the IDs of the vm snapshots, mutually exclusive with vmsnapshotid + false + list + 4.9 + list + + + + + id + the ID of the vm snapshot + string + + + account + the account associated with the disk volume + string + + + created + the create date of the vm snapshot + date + + + current + indicates if this is current snapshot + boolean + + + description + the description of the vm snapshot + string + + + displayname + the display name of the vm snapshot + string + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the domain to which the disk volume belongs + 4.19.2.0 + string + + + hypervisor + the type of hypervisor on which snapshot is stored + string + + + name + the name of the vm snapshot + string + + + parent + the parent ID of the vm snapshot + string + + + parentName + the parent displayName of the vm snapshot + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the vm snapshot + state + + + type + VM Snapshot type + string + + + virtualmachineid + the vm ID of the vm snapshot + string + + + virtualmachinename + the vm name of the vm snapshot + 4.15.1 + string + + + zoneid + the Zone ID of the vm snapshot + string + + + zonename + the Zone name of the vm snapshot + 4.15.1 + string + + + false + + + moveNetworkAclItem + Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list + true + + + id + The ID of the network ACL rule that is being moved to a new position. + true + string + + + aclconsistencyhash + Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field). + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + nextaclruleid + The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list. + false + string + + + previousaclruleid + The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list. + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listBaremetalDhcp + list baremetal dhcp servers + false + + + physicalnetworkid + the Physical Network ID + true + uuid + + + dhcpservertype + Type of DHCP device + false + string + + + id + DHCP server device ID + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + device id of + string + + + dhcpservertype + name of the provider + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + disassociateIpAddress + Disassociates an IP address from the account. + true + + + id + the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter + false + uuid + + + ipaddress + IP Address to be disassociated. Mutually exclusive with the id parameter + false + 4.19.0 + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + enableStorageMaintenance + Puts storage pool into maintenance state + true + + + id + Primary storage ID + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeSecondaryStorageSelector + Removes an existing secondary storage selector. + false + 4.19.0 + + + id + The unique identifier of the secondary storage selector to be removed. + true + uuid + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + listApis + lists all available apis on the server, provided by the Api Discovery plugin + false + 4.1.0 + + + name + API name + false + string + + + + + description + description of the api + string + + + isasync + true if api is asynchronous + boolean + + + name + the name of the api command + string + + + related + comma separated related apis + string + + + since + version of CloudStack the api was introduced in + string + + + type + response field type + string + + + params(*) + the list params the api accepts + + + description + description of the api parameter + string + + + length + length of the parameter + int + + + name + the name of the api parameter + string + + + related + comma separated related apis to get the parameter + string + + + required + true if this parameter is required for the api request + boolean + + + since + version of CloudStack the api was introduced in + string + + + type + parameter type + string + + + set + + + response(*) + api response fields + + + description + description of the api response field + string + + + name + the name of the api response field + string + + + response + api response fields + set + + + type + response field type + string + + + set + + + false + + + deleteBaremetalRct + deletes baremetal rack configuration text + true + + + id + RCT id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVMSnapshot + Creates snapshot for a vm. + true + 4.2.0 + + + virtualmachineid + The ID of the vm + true + uuid + + + description + The description of the snapshot + false + string + + + name + The display name of the snapshot + false + string + + + quiescevm + quiesce vm if true + false + boolean + + + snapshotmemory + snapshot memory if true + false + boolean + + + + + id + the ID of the vm snapshot + string + + + account + the account associated with the disk volume + string + + + created + the create date of the vm snapshot + date + + + current + indicates if this is current snapshot + boolean + + + description + the description of the vm snapshot + string + + + displayname + the display name of the vm snapshot + string + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the domain to which the disk volume belongs + 4.19.2.0 + string + + + hypervisor + the type of hypervisor on which snapshot is stored + string + + + name + the name of the vm snapshot + string + + + parent + the parent ID of the vm snapshot + string + + + parentName + the parent displayName of the vm snapshot + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the vm snapshot + state + + + type + VM Snapshot type + string + + + virtualmachineid + the vm ID of the vm snapshot + string + + + virtualmachinename + the vm name of the vm snapshot + 4.15.1 + string + + + zoneid + the Zone ID of the vm snapshot + string + + + zonename + the Zone name of the vm snapshot + 4.15.1 + string + + + false + + + deleteLoadBalancer + Deletes an internal load balancer + true + 4.2.0 + + + id + the ID of the Load Balancer + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricTagType + Lists Tungsten-Fabric tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + tagtypeuuid + the uuid of Tungsten-Fabric tag type + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric tag type name + string + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listSSHKeyPairs + List registered keypairs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fingerprint + A public key fingerprint to look for + false + string + + + id + the ID of the ssh keypair + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + A key pair name to look for + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the keypair + string + + + domain + the domain name of the keypair owner + string + + + domainid + the domain id of the keypair owner + string + + + fingerprint + Fingerprint of the public key + string + + + name + Name of the keypair + string + + + project + the project name of the keypair owner + string + + + projectid + the project id of the keypair owner + string + + + false + + + cancelStorageMaintenance + Cancels maintenance for primary storage + true + + + id + the primary storage ID + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + quotaSummary + Lists balance and quota usage for all accounts + false + 4.7.0 + + + account + Optional, Account Id for which statement needs to be generated + false + string + + + domainid + Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain. + false + uuid + + + keyword + List by keyword + false + string + + + listall + Optional, to list all accounts irrespective of the quota activity + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + + + account + account name + string + + + accountid + account id + string + + + balance + account balance + bigdecimal + + + currency + currency + string + + + domain + domain name + string + + + domainid + domain id + string + + + enddate + end date + date + + + quota + quota usage of this period + bigdecimal + + + quotaenabled + if the account has the quota config enabled + boolean + + + startdate + start date + date + + + state + account state + state + + + false + + + updateSnapshotPolicy + Updates the snapshot policy. + true + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the snapshot policy to the end user or not. + false + 4.4 + boolean + + + id + the ID of the snapshot policy + false + uuid + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + zone + The list of zones in which snapshot backup is scheduled + 4.19.0 + set + + + false + + + registerNetscalerControlCenter + Adds a netscaler control center device + true + + + ipaddress + URL of the netscaler controlcenter appliance. + true + string + + + numretries + Credentials to reach netscaler controlcenter device + true + integer + + + password + Credentials to reach netscaler controlcenter device + true + string + + + username + Credentials to reach netscaler controlcenter device + true + string + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + queryAsyncJobResult + Retrieves the current status of asynchronous job. + false + + + jobid + the ID of the asynchronous job + true + uuid + + + + + account + the account that executed the async command + string + + + accountid + the account id that executed the async command + string + + + cmd + the async command executed + string + + + completed + the completed date of the job + date + + + created + the created date of the job + date + + + domainid + the domain id that executed the async command + string + + + domainpath + the domain that executed the async command + string + + + jobinstanceid + the unique ID of the instance/entity object related to the job + string + + + jobinstancetype + the instance/entity object related to the job + string + + + jobprocstatus + the progress information of the PENDING job + integer + + + jobresult + the result reason + responseobject + + + jobresultcode + the result code for the job + integer + + + jobresulttype + the result type + string + + + jobstatus + the current job status-should be 0 for PENDING + integer + + + managementserverid + the msid of the management server on which the job is running + 4.19 + long + + + userid + the user that executed the async command + string + + + jobid + the ID of the async job + + + false + + + createCounter + Adds metric counter for VM auto scaling + true + + + name + Name of the counter. + true + string + + + provider + Network provider of the counter. + true + 4.18.0 + string + + + source + Source of the counter. + true + string + + + value + Value of the counter e.g. oid in case of snmp. + true + string + + + + + id + the id of the Counter + string + + + name + Name of the counter. + string + + + provider + Provider of the counter. + string + + + source + Source of the counter. + string + + + value + Value in case of snmp or other specific counters. + string + + + zoneid + zone id of counter + string + + + false + + + listEventTypes + List Event Types + false + + + + name + Event Type + string + + + false + + + prepareForShutdown + Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted + false + 4.19.0 + + + managementserverid + the uuid of the management server + true + uuid + + + + + managementserverid + The id of the management server + long + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + deleteTrafficMonitor + Deletes an traffic monitor host. + false + + + id + Id of the Traffic Monitor Host. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addCluster + Adds a new cluster + false + + + clustername + the cluster name + true + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged + true + string + + + hypervisor + hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3 + true + string + + + podid + the Pod ID for the host + true + uuid + + + zoneid + the Zone ID for the cluster + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + guestvswitchname + Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting. + false + string + + + guestvswitchtype + Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch) + false + string + + + ovm3cluster + Ovm3 native OCFS2 clustering enabled for cluster + false + string + + + ovm3pool + Ovm3 native pooling enabled for cluster + false + string + + + ovm3vip + Ovm3 vip to use for pool (and cluster) + false + string + + + password + the password for the host + false + string + + + publicvswitchname + Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting. + false + string + + + publicvswitchtype + Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch) + false + string + + + url + the URL + false + string + + + username + the username for the cluster + false + string + + + vsmipaddress + the ipaddress of the VSM associated with this cluster + false + string + + + vsmpassword + the password for the VSM associated with this cluster + false + string + + + vsmusername + the username for the VSM associated with this cluster + false + string + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + removeNicFromVirtualMachine + Removes VM from specified network by deleting a NIC + true + + + nicid + NIC ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listDedicatedHosts + Lists dedicated hosts. + false + + + account + the name of the account associated with the host. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated hosts by affinity group + false + uuid + + + domainid + the ID of the domain associated with the host + false + uuid + + + hostid + the ID of the host + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the host + string + + + affinitygroupid + the Dedication Affinity Group ID of the host + string + + + domainid + the domain ID of the host + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + false + + + getUploadParamsForIso + upload an existing ISO into the CloudStack cloud. + false + 4.13 + + + format + the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume/template/iso + true + string + + + zoneid + the ID of the zone the volume/template/iso is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + bootable + true if this ISO is bootable. If not passed explicitly its assumed to be true + false + boolean + + + checksum + the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + displaytext + the display text of the ISO. This is usually used for display purposes. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isextractable + true if the ISO or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if you want this ISO to be featured + false + boolean + + + ispublic + true if you want to register the ISO to be publicly available to all users, false otherwise. + false + boolean + + + ostypeid + the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed + false + uuid + + + projectid + Upload volume/template/iso for the project + false + uuid + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + getDiagnosticsData + Get diagnostics and files from system VMs + true + 4.14.0.0 + + + targetid + The ID of the system VM instance to retrieve diagnostics data files from + true + uuid + + + files + A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided. + false + list + list + + + + + url + Storage URL to download retrieve diagnostics data files + string + + + false + + + listPaloAltoFirewalls + lists Palo Alto firewall devices in a physical network + false + + + fwdeviceid + Palo Alto firewall device ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + deleteAutoScaleVmGroup + Deletes a autoscale vm group. + true + + + id + the ID of the autoscale group + true + uuid + + + cleanup + true if all VMs have to be cleaned up, false otherwise + false + 4.18.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateLoadBalancerRule + Updates load balancer + true + + + id + the ID of the load balancer rule to update + true + uuid + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + description + the description of the load balancer rule + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + name + the name of the load balancer rule + false + string + + + protocol + The protocol for the LB + false + string + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + enableAccount + Enables an account + false + + + account + Enables specified account. + false + string + + + domainid + Enables specified account in this domain. + false + uuid + + + id + Account id + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + changeStoragePoolScope + Changes the scope of a storage pool when the pool is in Disabled state.This feature is officially tested and supported for Hypervisors: KVM and VMware, Protocols: NFS and Ceph, and Storage Provider: DefaultPrimary. There might be extra steps involved to make this work for other hypervisors and storage options. + true + 4.19.1 + + + id + the Id of the storage pool + true + uuid + + + scope + the scope of the storage: cluster or zone + true + string + + + clusterid + the Id of the cluster to use if scope is being set to Cluster + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetwork + Deletes a network + true + + + id + the ID of the network + true + uuid + + + forced + Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + startKubernetesCluster + Starts a stopped CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + reconnectHost + Reconnects a host. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteProject + Deletes a project + true + 3.0.0 + + + id + id of the project to be deleted + true + uuid + + + cleanup + true if all project resources have to be cleaned up, false otherwise + false + 4.16.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addNetscalerLoadBalancer + Adds a netscaler load balancer device + true + + + networkdevicetype + Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer + true + string + + + password + Credentials to reach netscaler load balancer device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the netscaler load balancer appliance. + true + string + + + username + Credentials to reach netscaler load balancer device + true + string + + + gslbprovider + true if NetScaler device being added is for providing GSLB service + false + boolean + + + gslbproviderprivateip + private IP of the site + false + string + + + gslbproviderpublicip + public IP of the site + false + string + + + isexclusivegslbprovider + true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB + false + boolean + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + listIsoPermissions + List iso visibility and all accounts that have permissions to view this iso. + false + + + id + the template ID + true + uuid + + + + + id + the template ID + string + + + account + the list of accounts the template is available for + list + + + domainid + the ID of the domain to which the template belongs + string + + + ispublic + true if this template is a public template, false otherwise + boolean + + + projectids + the list of projects the template is available for + list + + + false + + + listBackupSchedule + List backup schedule of a VM + false + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + intervaltype + the interval type of the backup schedule + intervaltype + + + schedule + time the backup is scheduled to be taken. + string + + + timezone + the time zone of the backup schedule + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + false + + + restoreVolumeFromBackupAndAttachToVM + Restore and attach a backed up volume to VM + true + 4.14.0 + + + backupid + ID of the VM backup + true + uuid + + + virtualmachineid + id of the VM where to attach the restored volume + true + uuid + + + volumeid + ID of the volume backed up + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + configTungstenFabricService + config Tungsten-Fabric service + false + + + physicalnetworkid + the ID of physical network + true + uuid + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + removeNetworkPermissions + Removes network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + accountids + a comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + accounts + a comma delimited list of accounts within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + projectids + a comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBaremetalPxeServers + list baremetal pxe server + false + + + physicalnetworkid + the Physical Network ID + true + uuid + + + id + Pxe server device ID + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + device id of + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + listLoadBalancerRules + Lists load balancer rules. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer rule + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the load balancer rule + false + string + + + networkid + list by network ID the rule belongs to + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + publicipid + the public IP address ID of the load balancer rule + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + the ID of the virtual machine of the load balancer rule + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getUser + Find user account by API key + false + + + userapikey + API key of the user + true + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + listCiscoNexusVSMs + Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster + false + + + clusterid + Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance. + false + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + createManagementNetworkIpRange + Creates a Management network IP range. + true + 4.11.0.0 + + + gateway + The gateway for the management network. + true + string + + + netmask + The netmask for the management network. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + startip + The starting IP address. + true + string + + + endip + The ending IP address. + false + string + + + forsystemvms + Specify if range is dedicated for CPVM and SSVM. + false + boolean + + + vlan + Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + addVpnUser + Adds vpn users + true + + + password + password for the username + true + string + + + username + username for the vpn user + true + string + + + account + an optional account for the vpn user. Must be used with domainId. + false + string + + + domainid + an optional domainId for the vpn user. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + add vpn user to the specific project + false + uuid + + + + + id + the vpn userID + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'. + string + + + username + the username of the vpn user + string + + + false + + + deleteBackup + Delete VM backup + true + 4.14.0 + + + id + id of the VM backup + true + uuid + + + forced + force the deletion of backup which removes the entire backup chain but keep VM in Backup Offering + false + 4.18.0.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteProjectRolePermission + Deletes a project role permission in the project + false + 4.15.0 + + + id + ID of the project role permission to be deleted + true + uuid + + + projectid + ID of the project where the project role permission is to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateQuarantinedIp + Updates the quarantine end date for the given public IP address. + false + 4.19 + + + enddate + The date when the quarantine will no longer be active. + true + date + + + id + The ID of the public IP address in active quarantine. + false + uuid + + + ipaddress + The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine. + false + string + + + + + id + ID of the quarantine process. + string + + + created + When the quarantine was created. + date + + + enddate + End date for the quarantine. + date + + + ipaddress + The public IP address in quarantine. + string + + + previousownerid + Account ID of the previous public IP address owner. + string + + + previousownername + Account name of the previous public IP address owner. + string + + + removalreason + The reason for removing the IP from quarantine prematurely. + string + + + removed + When the quarantine was removed. + date + + + removeraccountid + ID of the account that removed the IP from quarantine. + string + + + false + + + updateVnfTemplate + Updates a template to VNF template or attributes of a VNF template. + false + 4.19.0 + + + id + the ID of the image file + true + uuid + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + cleanupvnfdetails + optional boolean field, which indicates if VNF details will be cleaned up or not + false + boolean + + + cleanupvnfnics + optional boolean field, which indicates if VNF nics will be cleaned up or not + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + string + + + vnfdetails + VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0 + false + map + map + + + vnfnics + VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC + false + map + map + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateVPCOffering + Updates VPC offering + true + + + id + the id of the VPC offering + true + uuid + + + displaytext + the display text of the VPC offering + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + name + the name of the VPC offering + false + string + + + sortkey + sort key of the VPC offering, integer + false + integer + + + state + update state for the VPC offering; supported states - Enabled/Disabled + false + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + listSamlAuthorization + Lists authorized users who can used SAML SSO + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + userid + User uuid + false + uuid + + + + + idpid + the authorized Identity Provider ID + string + + + status + the SAML authorization status + boolean + + + userid + the user ID + string + + + false + + + listUserTwoFactorAuthenticatorProviders + Lists user two factor authenticator providers + false + 4.18.0 + + + name + List user two factor authenticator provider by name + false + string + + + + + description + the description of the user two factor authenticator provider + string + + + name + the user two factor authenticator provider name + string + + + false + + + scaleVirtualMachine + Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume. + true + + + id + The ID of the virtual machine + true + uuid + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + automigrate + Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering + false + 4.17 + boolean + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + maxiops + New maximum number of IOPS for the custom disk offering + false + 4.17 + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + 4.17 + long + + + shrinkok + Verify OK to Shrink + false + 4.17 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateEgressFirewallRule + Updates egress firewall rule + true + 4.4 + + + id + the ID of the egress firewall rule + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listServiceOfferings + Lists all available service offerings. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + cpunumber + the CPU number that listed offerings must support + false + 4.15 + integer + + + cpuspeed + the CPU speed that listed offerings must support + false + 4.15 + integer + + + domainid + list only resources belonging to the domain specified + false + uuid + + + encryptroot + listed offerings support root disk encryption + false + 4.18 + boolean + + + id + ID of the service offering + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issystem + is this a system vm offering + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + memory + the RAM memory that listed offering must support + false + 4.15 + integer + + + name + name of the service offering + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings. + false + 4.19 + string + + + storagetype + the storage type of the service offering. Values are local and shared. + false + 4.19 + string + + + systemvmtype + the system VM type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter". + false + string + + + virtualmachineid + the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to. + false + uuid + + + zoneid + id of zone disk offering is associated with + false + 4.13 + uuid + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + state + state of the service offering + string + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + listOsCategories + Lists all supported OS categories for this cloud. + false + + + id + list Os category by id + false + uuid + + + keyword + List by keyword + false + string + + + name + list os category by name + false + 3.0.1 + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the OS category + string + + + name + the name of the OS category + string + + + false + + + importVm + Import virtual machine from a unmanaged host into CloudStack + true + 4.19.0 + + + clusterid + the cluster ID + true + uuid + + + hypervisor + hypervisor type of the host + true + string + + + importsource + Source location for Import + true + string + + + name + the name of the instance as it is known to the hypervisor + true + string + + + serviceofferingid + the service offering for the virtual machine + true + uuid + + + zoneid + the zone ID + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + clustername + (only for importing VMs from VMware to KVM) Name of VMware cluster. + false + string + + + convertinstancehostid + (only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v migration from VMware to KVM. + false + uuid + + + convertinstancepoolid + (only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM. + false + uuid + + + datacentername + (only for importing VMs from VMware to KVM) Name of VMware datacenter. + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping using keys disk and diskOffering + false + map + map + + + details + used to specify the custom parameters. + false + map + map + + + diskpath + path of the disk image + false + string + + + displayname + the display name of the instance + false + string + + + domainid + import instance to the domain specified + false + uuid + + + existingvcenterid + (only for importing VMs from VMware to KVM) UUID of a linked existing vCenter + false + uuid + + + forced + VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated + false + boolean + + + forcemstoimportvmfiles + (only for importing VMs from VMware to KVM) optional - if true, forces MS to import VM file(s) to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not. + false + boolean + + + host + the host name or IP address + false + string + + + hostid + Host where local disk is located + false + uuid + + + hostip + (only for importing VMs from VMware to KVM) VMware ESXi host IP/Name. + false + string + + + hostname + the host name of the instance + false + string + + + migrateallowed + vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool + false + boolean + + + networkid + the network ID + false + uuid + + + nicipaddresslist + VM nic to ip address mapping using keys nic, ip4Address + false + map + map + + + nicnetworklist + VM nic to network id mapping using keys nic and network + false + map + map + + + password + the password for the host + false + string + + + projectid + import instance for the project + false + uuid + + + storageid + Shared storage pool where disk is located + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + temppath + Temp Path on external host for disk image copy + false + string + + + username + the username for the host + false + string + + + vcenter + (only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeFromGlobalLoadBalancerRule + Removes a load balancer rule association with global load balancer rule + true + + + id + The ID of the load balancer rule + true + uuid + + + loadbalancerrulelist + the list load balancer rules that will be assigned to global load balancer rule + true + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAffinityGroupTypes + Lists affinity group types available + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + type + the type of the affinity group + string + + + false + + + listCapacity + Lists all the system wide capacities. + false + + + clusterid + lists capacity by the Cluster ID + false + 3.0.0 + uuid + + + fetchlatest + recalculate capacities and fetch the latest + false + 3.0.0 + boolean + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists capacity by the Pod ID + false + uuid + + + sortby + Sort the results. Available values: Usage + false + 3.0.0 + string + + + type + lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90. + false + integer + + + zoneid + lists capacity by the Zone ID + false + uuid + + + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + false + + + updateServiceOffering + Updates a service offering. + false + + + id + the ID of the service offering to be updated + true + uuid + + + displaytext + the display text of the service offering to be updated + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + hosttags + the host tag for this service offering. + false + 4.16 + string + + + name + the name of the service offering to be updated + false + string + + + sortkey + sort key of the service offering, integer + false + integer + + + state + state of the service offering + false + string + + + storagetags + comma-separated list of tags for the service offering, tags should match with existing storage pool tags + false + 4.16 + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + state + state of the service offering + string + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + stopVirtualMachine + Stops a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createNetworkACLList + Creates a network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone. + true + + + name + Name of the network ACL list + true + string + + + description + Description of the network ACL list + false + string + + + fordisplay + an optional field, whether to the display the list to the end user or not + false + 4.4 + boolean + + + vpcid + ID of the VPC associated with this network ACL list + false + uuid + + + + + id + the ID of the ACL + string + + + description + Description of the ACL + string + + + fordisplay + is ACL for display to the regular user + 4.4 + boolean + + + name + the Name of the ACL + string + + + vpcid + Id of the VPC this ACL is associated with + string + + + vpcname + Name of the VPC this ACL is associated with + string + + + false + + \ No newline at end of file diff --git a/4.20_commands.xml b/4.20_commands.xml new file mode 100644 index 0000000..4dd9852 --- /dev/null +++ b/4.20_commands.xml @@ -0,0 +1,140119 @@ + + + createVPCOffering + Creates VPC offering + true + + + name + the name of the vpc offering + true + string + + + displaytext + the display text of the vpc offering, defaults to the 'name' + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + enable + set to true if the offering is to be enabled during creation. Default is false + false + 4.16 + boolean + + + fornsx + true if network offering is meant to be used for NSX, false otherwise. + false + 4.20.0 + boolean + + + internetprotocol + The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6 + false + 4.17.0 + string + + + networkmode + Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED + false + 4.20.0 + string + + + nsxsupportlb + true if network offering for NSX VPC offering supports Load balancer service. + false + 4.20.0 + boolean + + + routingmode + the routing mode for the VPC offering. Supported types are: Static or Dynamic. + false + 4.20.0 + string + + + servicecapabilitylist + desired service capabilities as part of vpc offering + false + map + 4.4 + map + + + serviceofferingid + the ID of the service offering for the VPC router appliance + false + uuid + + + serviceproviderlist + provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network + false + map + map + + + specifyasnumber + true if the VPC offering supports choosing AS number + false + 4.20.0 + boolean + + + supportedservices + services supported by the vpc offering + false + list + list + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + fornsx + true if vpc offering can be used by NSX networks only + boolean + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + networkmode + Mode in which the network will operate. The valid values are NATTED and ROUTED + string + + + routingmode + the routing mode for the network offering, supported types are Static or Dynamic. + string + + + specifyasnumber + true if network offering supports choosing AS numbers + boolean + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + ldapCreateAccount + Creates an account from an LDAP user + false + 4.2.0 + + + username + Unique username. + true + string + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accountid + Account UUID, required for adding account from external provisioning system + false + string + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + Creates the user under the specified domain. + false + uuid + + + networkdomain + Network domain for the account's networks + false + string + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + taggedresources + The tagged resource limit and count for the account + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + copyIso + Copies an iso from one zone to another. + true + + + id + Template ID. + true + uuid + + + destzoneid + ID of the zone the template is being copied to. + false + uuid + + + destzoneids + 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. + false + list + list + + + sourcezoneid + 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. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteAutoScaleVmProfile + Deletes a autoscale vm profile. + true + + + id + the ID of the autoscale profile + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVsphereStoragePolicyCompatiblePools + List storage pools compatible with a vSphere storage policy + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + policyid + ID of the storage policy + false + uuid + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + rebootSystemVm + Reboots a system VM. + true + + + id + The ID of the system virtual machine + true + uuid + + + forced + Force reboot the system VM (System VM is Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + listDedicatedZones + List dedicated zones. + false + + + account + the name of the account associated with the zone. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated zones by affinity group + false + uuid + + + domainid + the ID of the domain associated with the zone + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of the Zone + false + uuid + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Zone is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the zone + string + + + domainid + the domain ID to which the Zone is dedicated + string + + + zoneid + the ID of the Zone + string + + + zonename + the Name of the Zone + string + + + false + + + listElastistorPool + Lists the pools of elastistor + false + + + id + the ID of the Pool + false + long + + + + + id + the ID of the storage pool + string + + + controllerid + controller of the pool + string + + + gateway + default gateway of the pool + string + + + maxiops + available iops of the pool + long + + + name + the name of the storage pool + string + + + size + the current available space of the pool + long + + + state + the state of the storage pool + string + + + false + + + changeBgpPeersForNetwork + Change the BGP peers for a network. + true + 4.20.0 + + + networkid + UUID of the network which the Bgp Peers are associated to. + true + uuid + + + bgppeerids + Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked. + false + list + list + + + + + id + id of the bgp peer + string + + + account + the account of the bgp peer + string + + + asnumber + AS number of bgp peer + long + + + created + date when this bgp peer was created. + date + + + details + additional key/value details of the bgp peer + map + + + domain + the domain name of the bgp peer + string + + + domainid + the domain ID of the bgp peer + string + + + ip6address + IPv6 address of bgp peer + string + + + ipaddress + IPv4 address of bgp peer + string + + + password + password of bgp peer + string + + + project + the project name of the bgp peer + string + + + projectid + the project id of the bgp peer + string + + + zoneid + id of zone to which the bgp peer belongs to. + string + + + zonename + name of zone to which the bgp peer belongs to. + string + + + false + + + listTungstenFabricLBHealthMonitor + list Tungsten-Fabric LB health monitor + false + + + lbruleid + the ID of lb rule + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the health monitor ID + long + + + expectedcode + the health monitor expected code + string + + + httpmethod + the health monitor http method + string + + + interval + the health monitor interval + int + + + lbruleid + the LB rule ID + string + + + retry + the health monitor retry + int + + + timeout + the health monitor timeout + int + + + type + the health monitor type + string + + + urlpath + the health monitor url path + string + + + uuid + the health monitor UUID + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + deleteAccountFromProject + Deletes account from the project + true + 3.0.0 + + + account + name of the account to be removed from the project + true + string + + + projectid + ID of the project to remove the account from + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateGuestOs + Updates the information about Guest OS + true + 4.4.0 + + + id + UUID of the Guest OS + true + uuid + + + osdisplayname + Unique display name for Guest OS + true + string + + + details + Map of (key/value pairs) + false + map + map + + + forDisplay + whether this guest OS is available for end users + false + boolean + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + fordisplay + is the guest OS visible for the users + boolean + + + isuserdefined + is the guest OS user defined + boolean + + + name + the name of the OS type + string + + + oscategoryid + the ID of the OS category + string + + + oscategoryname + the name of the OS category + string + + + false + + + listGuestVlans + Lists all guest vlans + false + 4.17.0 + + + allocatedonly + limits search results to allocated guest vlan. false by default. + false + boolean + + + id + list guest vlan by id + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + list guest vlan by physical network + false + uuid + + + vnet + list guest vlan by vnet + false + string + + + zoneid + list guest vlan by zone + false + uuid + + + + + id + the guest VLAN id + long + + + account + the account of the guest VLAN range + string + + + allocationstate + the allocation state of the guest VLAN + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + domainpath + path of the domain to which the guest VLAN range belongs + 4.19.2.0 + string + + + isdedicated + true if the guest VLAN is dedicated to the account + boolean + + + network + the list of networks who use this guest VLAN + list + + + physicalnetworkid + the physical network ID of the guest VLAN range + string + + + physicalnetworkname + the physical network name of the guest VLAN range + string + + + project + the project name of the guest VLAN range + string + + + projectid + the project id of the guest VLAN range + string + + + taken + date the guest VLAN was taken + date + + + vlan + the guest VLAN + string + + + zoneid + the zone ID of the guest VLAN range + string + + + zonename + the zone name of the guest VLAN range + string + + + false + + + updateResourceLimit + Updates resource limits for an account or domain. + false + + + resourcetype + Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + true + integer + + + account + Update resource for a specified account. Must be used with the domainId parameter. + false + string + + + domainid + 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. + false + uuid + + + max + Maximum resource limit. + false + long + + + projectid + Update resource limits for project + false + uuid + + + tag + Tag for the resource type + false + 4.20.0 + string + + + + + account + the account of the resource limit + string + + + domain + the domain name of the resource limit + string + + + domainid + the domain ID of the resource limit + string + + + domainpath + path of the domain to which the resource limit belongs + 4.19.2.0 + string + + + max + the maximum number of the resource. A -1 means the resource currently has no limit. + long + + + project + the project name of the resource limit + string + + + projectid + the project id of the resource limit + string + + + resourcetype + 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. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + tag + The tag for the resource limit + 4.20.0 + string + + + false + + + deleteStaticRoute + Deletes a static route + true + + + id + the ID of the static route + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getLoadBalancerSslCertificate + get load balancer certificate + false + + + id + the ID of Lb + true + uuid + + + + + chain + chain + string + + + crt + crt + string + + + key + key + string + + + false + + + deleteRemoteAccessVpn + Destroys a l2tp/ipsec remote access vpn + true + + + publicipid + public ip address id of the vpn server + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + startRollingMaintenance + Start rolling maintenance + true + + + clusterids + the IDs of the clusters to start maintenance on + false + list + list + + + forced + if rolling mechanism should continue in case of an error + false + boolean + + + hostids + the IDs of the hosts to start maintenance on + false + list + list + + + payload + the command to execute while hosts are on maintenance + false + string + + + podids + the IDs of the pods to start maintenance on + false + list + list + + + timeout + optional operation timeout (in seconds) that overrides the global timeout setting + false + integer + + + zoneids + the IDs of the zones to start maintenance on + false + list + list + + + + + details + in case of failure, details are displayed + string + + + success + indicates if the rolling maintenance operation was successful + boolean + + + hostsskipped(*) + the hosts skipped + + + hostid + the ID of the skipped host + string + + + hostname + the name of the skipped host + string + + + reason + the reason to skip the host + string + + + list + + + hostsupdated(*) + the hosts updated + + + enddate + end date of the update on the host + string + + + hostid + the ID of the updated host + string + + + hostname + the name of the updated host + string + + + output + output of the maintenance script on the host + string + + + startdate + start date of the update on the host + string + + + list + + + false + + + listTungstenFabricApplicationPolicySet + list Tungsten-Fabric application policy set + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + firewallpolicy + list Tungsten-Fabric firewall policy + list + + + name + Tungsten-Fabric policy name + string + + + tag + list Tungsten-Fabric tag + list + + + uuid + Tungsten-Fabric application policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateNetworkACLList + Updates network ACL list + true + 4.4 + + + id + the ID of the network ACL + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + description + Description of the network ACL list + false + string + + + fordisplay + an optional field, whether to the display the list to the end user or not + false + 4.4 + boolean + + + name + Name of the network ACL list + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + restoreVirtualMachine + Restore a VM to original template/ISO or new template/ISO + true + 3.0.0 + + + virtualmachineid + Virtual Machine ID + true + uuid + + + details + used to specify the custom parameters + false + map + 4.19.1 + map + + + diskofferingid + Override root volume's diskoffering. + false + 4.19.1 + uuid + + + expunge + Optional field to expunge old root volume after restore. + false + 4.19.1 + boolean + + + rootdisksize + Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.19.1 + long + + + templateid + 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 + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteNiciraNvpDevice + delete a nicira nvp device + true + + + nvpdeviceid + Nicira device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + notifyBaremetalProvisionDone + Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user + true + + + mac + mac of the nic used for provision + true + object + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUcsBlades + List ucs blades + false + + + ucsmanagerid + ucs manager id + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + ucs blade id + string + + + bladedn + ucs blade dn + string + + + hostid + cloudstack host id this blade associates to + string + + + profiledn + associated ucs profile dn + string + + + ucsmanagerid + ucs manager id + string + + + false + + + getVolumeSnapshotDetails + Get Volume Snapshot Details + false + + + snapshotid + CloudStack Snapshot UUID + true + string + + + + + volumeiScsiName + Volume iSCSI Name + string + + + false + + + updateHost + Updates a host. + false + + + id + the ID of the host to update + true + uuid + + + allocationstate + Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable + false + string + + + annotation + Add an annotation to this host + false + 4.11 + string + + + hosttags + list of tags to be added to the host + false + list + list + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + false + boolean + + + name + Change the name of host + false + 4.15 + string + + + oscategoryid + the id of Os category to update the host with + false + uuid + + + url + the new uri for the secondary storage: nfs://host/path + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + arch + CPU Arch of the host + 4.20 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + explicithosttags + comma-separated list of explicit host tags for the host + 4.20.0 + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + implicithosttags + comma-separated list of implicit host tags for the host + 4.20.0 + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createEgressFirewallRule + Creates a egress firewall rule for a given network + true + + + networkid + the network id of the port forwarding rule + true + uuid + + + protocol + the protocol for the firewall rule. Valid values are TCP/UDP/ICMP. + true + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + destcidrlist + the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + startport + the starting port of firewall rule + false + integer + + + type + type of firewallrule: system/user + false + string + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listSecurityGroups + Lists security groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list the security group by the id provided + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + securitygroupname + lists security groups by name + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + lists security groups by virtual machine id + false + uuid + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listOauthProvider + List OAuth providers registered + false + 4.19.0 + + + id + the ID of the OAuth provider + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + Name of the provider + false + string + + + + + id + ID of the provider + string + + + clientid + Client ID registered in the OAuth provider + string + + + description + Description of the provider registered + string + + + enabled + Whether the OAuth provider is enabled or not + boolean + + + name + Name of the provider + string + + + provider + Name of the provider + string + + + redirecturi + Redirect URI registered in the OAuth provider + string + + + secretkey + Secret key registered in the OAuth provider + string + + + false + + + enableRole + Enables a role + false + 4.20.0 + + + id + ID of the role + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteServicePackageOffering + Delete Service Package + false + + + id + the service offering ID + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateSharedFileSystem + Update a Shared FileSystem + false + 4.20.0 + + + id + the ID of the shared filesystem + true + uuid + + + description + the description for the shared filesystem. + false + string + + + name + the name of the shared filesystem. + false + string + + + + + id + ID of the shared filesystem + string + + + account + the account associated with the shared filesystem + string + + + description + description of the shared filesystem + string + + + diskioread + the read (IO) of disk on the shared filesystem + long + + + diskiowrite + the write (IO) of disk on the shared filesystem + long + + + diskkbsread + the shared filesystem's disk read in KiB + long + + + diskkbswrite + the shared filesystem's disk write in KiB + long + + + diskofferingdisplaytext + disk offering display text for the shared filesystem + string + + + diskofferingid + disk offering ID for the shared filesystem + string + + + diskofferingname + disk offering for the shared filesystem + string + + + domain + the domain associated with the shared filesystem + string + + + domainid + the ID of the domain associated with the shared filesystem + string + + + domainpath + path of the domain to which the shared filesystem + string + + + filesystem + the filesystem format + string + + + iscustomdiskoffering + disk offering for the shared filesystem has custom size + boolean + + + name + name of the shared filesystem + string + + + networkid + Network ID of the shared filesystem + string + + + networkname + Network name of the shared filesystem + string + + + path + path to mount the shared filesystem + string + + + physicalsize + the bytes actually consumed on disk + long + + + project + the project name of the shared filesystem + string + + + projectid + the project ID of the shared filesystem + string + + + provider + the shared filesystem provider + string + + + provisioningtype + provisioning type used in the shared filesystem + string + + + serviceofferingid + service offering ID for the shared filesystem + string + + + serviceofferingname + service offering for the shared filesystem + string + + + size + size of the shared filesystem + long + + + sizegb + size of the shared filesystem in GiB + string + + + state + the state of the shared filesystem + string + + + storage + name of the storage pool hosting the data volume + string + + + storageid + ID of the storage pool hosting the data volume + string + + + utilization + the disk utilization + string + + + virtualmachineid + ID of the storage fs vm + string + + + virtualsize + the bytes allocated + long + + + vmstate + ID of the storage fs vm + string + + + volumeid + ID of the storage fs data volume + string + + + volumename + name of the storage fs data volume + string + + + zoneid + ID of the availability zone + string + + + zonename + Name of the availability zone + string + + + nic(*) + the list of nics associated with the shared filesystem + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + list + + + false + + + updateIpv4SubnetForZone + Updates an existing IPv4 subnet for a zone. + true + 4.20.0 + + + id + Id of the guest network IPv4 subnet + true + uuid + + + subnet + The new CIDR of the IPv4 subnet. + true + string + + + + + id + id of the guest IPv4 subnet + string + + + account + the account of the IPv4 subnet + string + + + created + date when this IPv4 subnet was created. + date + + + domain + the domain name of the IPv4 subnet + string + + + domainid + the domain ID of the IPv4 subnet + string + + + project + the project name of the IPv4 subnet + string + + + projectid + the project id of the IPv4 subnet + string + + + subnet + guest IPv4 subnet + string + + + zoneid + id of zone to which the IPv4 subnet belongs to. + string + + + zonename + name of zone to which the IPv4 subnet belongs to. + string + + + false + + + destroySystemVm + Destroys a system virtual machine. + true + + + id + The ID of the system virtual machine + true + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + archiveEvents + Archive one or more events. + false + + + enddate + end date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the events + false + list + list + + + startdate + start date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + archive by event type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listASNumbers + List Autonomous Systems Numbers + false + 4.20.0 + + + account + account name + false + string + + + asnrangeid + the AS Number range ID + false + uuid + + + asnumber + AS number + false + integer + + + domainid + domain id + false + uuid + + + isallocated + to indicate if the AS number is allocated to any network + false + boolean + + + keyword + List by keyword + false + string + + + networkid + the network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + vpcid + the vpc id + false + uuid + + + zoneid + the zone ID + false + uuid + + + + + id + ID of the AS Number + string + + + account + the account name + string + + + accountid + Account ID + string + + + allocated + Allocated Date + date + + + allocationstate + Allocation state + string + + + asnrange + AS Number Range + string + + + asnrangeid + AS Number ID + string + + + asnumber + AS Number + long + + + associatednetworkid + Network ID + string + + + associatednetworkname + Network Name + string + + + created + Created Date + date + + + domain + the domain name + string + + + domainid + Domain ID + string + + + vpcid + VPC ID + string + + + vpcname + VPC Name + string + + + zoneid + Zone ID + string + + + zonename + the zone name of the AS Number range + string + + + false + + + deleteSecondaryStagingStore + Deletes a secondary staging store . + false + 4.2.0 + + + id + the staging store ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listUserData + List registered userdatas + false + 4.18 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the Userdata + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + Userdata name to look for + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the userdata + string + + + accountid + the owner id of the userdata + string + + + domain + the domain name of the userdata owner + string + + + domainid + the domain id of the userdata owner + string + + + domainpath + path of the domain to which the userdata owner belongs + 4.19.2.0 + string + + + name + Name of the userdata + string + + + params + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + string + + + project + the project name of the userdata + 4.19.1 + string + + + projectid + the project id of the userdata + 4.19.1 + string + + + userdata + base64 encoded userdata content + string + + + false + + + updateLoadBalancer + Updates an internal load balancer + true + 4.4.0 + + + id + the ID of the load balancer + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + domainpath + path of the domain to which the Load Balancer belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + scaleSystemVm + Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect. + true + + + id + The ID of the system vm + true + uuid + + + serviceofferingid + the service offering ID to apply to the system vm + true + uuid + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + verifyOAuthCodeAndGetUser + Verify the OAuth Code and fetch the corresponding user from provider + false + 4.19.0 + + + provider + Name of the provider + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + secretcode + Code that is provided by OAuth provider (Eg. google, github) after successful login + false + string + + + + + id + ID of the provider + string + + + clientid + Client ID registered in the OAuth provider + string + + + description + Description of the provider registered + string + + + enabled + Whether the OAuth provider is enabled or not + boolean + + + name + Name of the provider + string + + + provider + Name of the provider + string + + + redirecturi + Redirect URI registered in the OAuth provider + string + + + secretkey + Secret key registered in the OAuth provider + string + + + false + + + listClusterDrsPlan + List DRS plans for a clusters + false + 4.19.0 + + + clusterid + ID of the cluster + false + uuid + + + id + ID of the drs plan + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + unique ID of the drs plan for cluster + string + + + clusterid + Id of the cluster + string + + + eventid + Start event Id of the DRS Plan + string + + + migrations + List of migrations + list + + + status + Status of DRS Plan + status + + + type + Type of DRS Plan (Automated or Manual)) + type + + + false + + + listClusters + Lists clusters. + false + + + allocationstate + lists clusters by allocation state + false + string + + + clustertype + lists clusters by cluster type + false + string + + + hypervisor + lists clusters by hypervisor type + false + string + + + id + lists clusters by the cluster ID + false + uuid + + + keyword + List by keyword + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + name + lists clusters by the cluster name + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists clusters by Pod ID + false + uuid + + + showcapacities + flag to display the capacity of the clusters + false + boolean + + + zoneid + lists clusters by Zone ID + false + uuid + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + arch + CPU Arch of the hosts in the cluster + 4.20 + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + tag + The tag for the capacity type + 4.20.0 + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + listProjectInvitations + Lists project invitations and provides detailed information for listed invitations + false + 3.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + activeonly + if true, list only active invitations - having Pending state and ones that are not timed out yet + false + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list invitations by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list by project id + false + uuid + + + state + list invitations by state + false + string + + + userid + list invitation by user ID + false + uuid + + + + + id + the id of the invitation + string + + + account + the account name of the project's owner + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + domainpath + path of the Domain the project belongs to + 4.19.2.0 + string + + + email + the email the invitation was sent to + string + + + project + the name of the project + string + + + projectid + the id of the project + string + + + state + the invitation state + string + + + userid + the User ID + string + + + false + + + listEgressFirewallRules + Lists all egress firewall rules for network ID. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the firewall services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + the network ID for the egress firewall services + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listClustersMetrics + Lists clusters metrics + false + 4.9.3 + + + allocationstate + lists clusters by allocation state + false + string + + + clustertype + lists clusters by cluster type + false + string + + + hypervisor + lists clusters by hypervisor type + false + string + + + id + lists clusters by the cluster ID + false + uuid + + + keyword + List by keyword + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + name + lists clusters by the cluster name + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists clusters by Pod ID + false + uuid + + + showcapacities + flag to display the capacity of the clusters + false + boolean + + + zoneid + lists clusters by Zone ID + false + uuid + + + + + cpuallocated + the total cpu allocated in Ghz + string + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpumaxdeviation + the maximum cpu deviation + string + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotal + the total cpu capacity in Ghz + string + + + cpuused + the total cpu used in Ghz + string + + + drsimbalance + DRS imbalance for the cluster + string + + + hosts + running / total hosts in the cluster + string + + + memoryallocated + the total cpu allocated in GiB + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorymaxdeviation + the maximum memory deviation + string + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotal + the total cpu capacity in GiB + string + + + memoryused + the total cpu used in GiB + string + + + state + state of the cluster + string + + + false + + + listStoragePoolObjects + Lists objects at specified path on a storage pool. + false + 4.19.0 + + + id + id of the storage pool + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + path to list on storage pool + false + string + + + + + format + Format of template associated with the data store object. + string + + + isdirectory + Is it a directory. + boolean + + + lastupdated + Last modified date of the file/directory. + date + + + name + Name of the data store object. + string + + + size + Size is in Bytes. + long + + + snapshotid + Snapshot ID associated with the data store object. + string + + + snapshotname + Snapshot Name associated with the data store object. + string + + + templateid + Template ID associated with the data store object. + string + + + templatename + Template Name associated with the data store object. + string + + + volumeid + Volume ID associated with the data store object. + string + + + volumename + Volume Name associated with the data store object. + string + + + false + + + createBackupSchedule + Creates a user-defined VM backup schedule + false + 4.14.0 + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + schedule + custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + date + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + listSecondaryStagingStores + Lists secondary staging stores. + false + 4.2.0 + + + id + the ID of the staging store + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the staging store + false + string + + + page + false + integer + + + pagesize + false + integer + + + protocol + the staging store protocol + false + string + + + provider + the staging store provider + false + string + + + zoneid + the Zone ID for the staging store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + startRouter + Starts a router. + true + + + id + the ID of the router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + resetConfiguration + Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings + false + 4.16.0 + + + name + the name of the configuration + true + string + + + accountid + the ID of the Account to reset the parameter value for corresponding account + false + uuid + + + clusterid + the ID of the Cluster to reset the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to reset the parameter value for corresponding domain + false + uuid + + + imagestoreid + the ID of the Image Store to reset the parameter value for corresponding image store + false + uuid + + + storageid + the ID of the Storage pool to reset the parameter value for corresponding storage pool + false + uuid + + + zoneid + the ID of the Zone to reset the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + deleteStratosphereSsp + Removes stratosphere ssp server + false + + + hostid + the host ID of ssp server + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createAutoScalePolicy + Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group. + true + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + true + string + + + conditionids + the list of IDs of the conditions that are being evaluated on every interval + true + list + list + + + duration + the duration in which the conditions have to be true before action is taken + true + integer + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + quiettime + the cool down period in which the policy should not be evaluated after the action has been taken + false + integer + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + domainpath + path of the domain to which the autoscale policy belongs + 4.19.2.0 + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + listUsageServerMetrics + Lists Usage Server metrics + false + 4.17.0 + + + + collectiontime + the time these statistics were collected + date + + + hostname + the name of the active usage server + string + + + lastheartbeat + the last time this Usage Server checked for jobs + date + + + lastsuccessfuljob + the last time a usage job successfully completed + date + + + state + the state of the usage server + state + + + false + + + enableHAForZone + Enables HA for a zone + true + 4.11 + + + zoneid + ID of the zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + cleanVMReservations + Cleanups VM reservations in the database. + true + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listObjectStoragePools + Lists object storage pools. + false + 4.19.0 + + + id + the ID of the storage pool + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the object store + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + the object store provider + false + string + + + + + id + the ID of the object store + string + + + name + the name of the object store + string + + + providername + the provider name of the object store + string + + + storagetotal + the total size of the object store + long + + + storageused + the object store currently used size + long + + + url + the url of the object store + string + + + false + + + updateRoutingFirewallRule + Updates Routing firewall rule with specified ID + true + 4.20.0 + + + id + the ID of the Routing firewall rule + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the Routing firewall rule to the end user or not + false + boolean + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createSecondaryStagingStore + create secondary staging store. + false + + + url + the URL for the staging store + true + string + + + details + the details for the staging store + false + map + map + + + provider + the staging store provider name + false + string + + + scope + the scope of the staging store: zone only for now + false + string + + + zoneid + the Zone ID for the staging store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + removeVmwareDc + Remove a VMware datacenter from a zone. + false + + + zoneid + The id of Zone from which VMware datacenter has to be removed. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateLBHealthCheckPolicy + Updates load balancer health check policy + true + 4.4 + + + id + ID of load balancer health check policy + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + removeTungstenFabricPolicyRule + remove Tungsten-Fabric policy + true + + + policyuuid + the Uuid of Tungsten-Fabric policy + true + string + + + ruleuuid + the Uuid of Tungsten-Fabric policy rule + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createLoadBalancerRule + Creates a load balancer rule + true + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + true + string + + + name + name of the load balancer rule + true + string + + + privateport + the private port of the private IP address/virtual machine where the network traffic will be load balanced to + true + integer + + + publicport + the public port from where the network traffic will be load balanced from + true + integer + + + account + the account associated with the load balancer. Must be used with the domainId parameter. + false + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed. + false + list + 4.18.0.0 + list + + + description + the description of the load balancer rule + false + string + + + domainid + the domain ID associated with the load balancer + false + uuid + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + networkid + The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case) + false + uuid + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true + false + boolean + + + protocol + The protocol for the LB such as tcp, udp or tcp-proxy. + false + string + + + publicipid + public IP address ID from where the network traffic will be load balanced from + false + uuid + + + zoneid + zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm + false + uuid + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + quotaListEmailConfiguration + List quota email template configurations + false + 4.20.0.0 + + + accountid + Account ID for which to list quota template email configurations + true + uuid + + + + + account + The configured account's id. + string + + + enabled + Whether the template is enabled. + boolean + + + minbalance + The configured account's min balance. + double + + + templatename + The template's name. + string + + + false + + + importVsphereStoragePolicies + Import vSphere storage policies + false + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the Storage Policy + string + + + description + the description of the Storage Policy + string + + + name + the name of the Storage Policy + string + + + policyid + the identifier of the Storage Policy in vSphere DataCenter + string + + + zoneid + the ID of the Zone + string + + + false + + + deleteBackupRepository + delete a backup repository + false + 4.20.0 + + + id + ID of the backup repository to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableOutOfBandManagementForZone + Disables out-of-band management for a zone + true + 4.9.0 + + + zoneid + the ID of the zone + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + createBackup + Create VM backup + true + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateVPC + Updates a VPC + true + + + id + the id of the VPC + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displaytext + the display text of the VPC + false + string + + + fordisplay + an optional field, whether to the display the vpc to the end user or not + false + 4.4 + boolean + + + name + the name of the VPC + false + string + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC + false + 4.19 + string + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + asnumber + AS NUMBER + 4.20.0 + long + + + asnumberid + UUID of AS NUMBER + 4.20.0 + string + + + bgppeers + The BGP peers for the VPC + 4.20.0 + set + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip4routes + The routes for the VPC to ease adding route in upstream router + 4.20.0 + set + + + ip4routing + The IPv4 routing mode of VPC + 4.20.0 + string + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + stopSystemVm + Stops a system VM. + true + + + id + The ID of the system virtual machine + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + deleteEgressFirewallRule + Deletes an egress firewall rule + true + + + id + the ID of the firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listIpv6FirewallRules + Lists all IPv6 firewall rules + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + boolean + + + id + Lists ipv6 firewall rule with the specified ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list ipv6 firewall rules by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + list ipv6 firewall rules by traffic type - ingress or egress + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listVMSchedule + List VM Schedules. + false + 4.19.0 + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + action + Action taken by schedule + false + string + + + enabled + ID of VM schedule + false + boolean + + + id + ID of VM schedule + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of VM schedule + string + + + action + Action + action + + + created + Date when the schedule was created + date + + + description + Description of VM schedule + string + + + enabled + VM schedule is enabled + boolean + + + enddate + Date after which the schedule becomes inactive + date + + + schedule + Cron formatted VM schedule + string + + + startdate + Date from which the schedule is active + date + + + timezone + Timezone of the schedule + string + + + virtualmachineid + ID of virtual machine + string + + + false + + + patchSystemVm + Attempts to live patch systemVMs - CPVM, SSVM + true + 4.17.0 + + + forced + If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only + false + boolean + + + id + patches systemVM - CPVM/SSVM with the specified ID + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVolumesMetrics + Lists volume metrics + false + 4.9.3 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster id the disk volume belongs to + false + uuid + + + diskofferingid + list volumes by disk offering + false + 4.4 + uuid + + + displayvolume + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hostid + list volumes on specified host + false + uuid + + + id + the ID of the disk volume + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id + false + list + 4.9 + list + + + isencrypted + list only volumes that are encrypted + false + 4.19.1 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + listsystemvms + list system VMs; only ROOT admin is eligible to pass this parameter + false + 4.18 + boolean + + + name + the name of the disk volume + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod id the disk volume belongs to + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + serviceofferingid + list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored + false + 4.19.1 + uuid + + + state + state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged. + false + string + + + storageid + the ID of the storage pool, available to ROOT admin only + false + 4.3 + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + type + the type of disk volume + false + string + + + virtualmachineid + the ID of the virtual machine + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + diskiopstotal + the total disk iops + long + + + sizegb + disk size in GiB + string + + + false + + + listDetailOptions + Lists all possible details and their options for a resource type such as a VM or a template + false + 4.13 + + + resourcetype + the resource type such as UserVm, Template etc. + true + string + + + resourceid + the UUID of the resource (optional) + false + string + + + + + details + Map of all possible details and their possible list of values + map + + + false + + + listSslCerts + Lists SSL certificates + false + + + accountid + Account ID + false + uuid + + + certid + ID of SSL certificate + false + uuid + + + lbruleid + Load balancer rule ID + false + uuid + + + projectid + Project that owns the SSL certificate + false + uuid + + + + + id + SSL certificate ID + string + + + account + account for the certificate + string + + + certchain + certificate chain + string + + + certificate + certificate + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + fingerprint + certificate fingerprint + string + + + loadbalancerrulelist + List of loabalancers this certificate is bound to + list + + + name + name + string + + + project + the project name of the certificate + string + + + projectid + the project id of the certificate + string + + + false + + + listPrivateGateways + List private gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list private gateway by id + false + uuid + + + ipaddress + list gateways by ip address + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + list gateways by state + false + string + + + vlan + list gateways by vlan + false + string + + + vpcid + list gateways by vpc + false + uuid + + + + + id + the id of the private gateway + string + + + account + the account associated with the private gateway + string + + + aclid + ACL Id set for private gateway + string + + + aclname + ACL name set for private gateway + string + + + domain + the domain associated with the private gateway + string + + + domainid + the ID of the domain associated with the private gateway + string + + + domainpath + path of the domain to which the private gateway belongs + 4.19.2.0 + string + + + gateway + the gateway + string + + + ipaddress + the private gateway's ip address + string + + + netmask + the private gateway's netmask + string + + + physicalnetworkid + the physical network id + string + + + project + the project name of the private gateway + string + + + projectid + the project id of the private gateway + string + + + sourcenatsupported + Source Nat enable status + boolean + + + state + State of the gateway, can be Creating, Ready, Deleting + string + + + vlan + the network implementation uri for the private gateway + string + + + vpcid + VPC id the private gateway belongs to + string + + + vpcname + VPC name the private gateway belongs to + 4.13.2 + string + + + zoneid + zone id of the private gateway + string + + + zonename + the name of the zone the private gateway belongs to + string + + + false + + + updateVmNicIp + Update the default Ip of a VM Nic + true + + + nicid + the ID of the nic to which you want to assign private IP + true + uuid + + + ipaddress + Secondary IP Address + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + startInternalLoadBalancerVM + Starts an existing internal lb vm. + true + + + id + the ID of the internal lb vm + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateDiskOffering + Updates a disk offering. + false + + + id + ID of the disk offering + true + uuid + + + bytesreadrate + bytes read rate of the disk offering + false + 4.15 + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + 4.15 + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + byteswriterate + bytes write rate of the disk offering + false + 4.15 + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + 4.15 + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + cachemode + the cache mode to use for this disk offering + false + 4.15 + string + + + displayoffering + an optional field, whether to display the offering to the end user or not. + false + boolean + + + displaytext + updates alternate display text of the disk offering with this value + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + 4.13 + string + + + iopsreadrate + io requests read rate of the disk offering + false + 4.15 + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + 4.15 + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + iopswriterate + io requests write rate of the disk offering + false + 4.15 + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + 4.15 + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + 4.15 + long + + + name + updates name of the disk offering with this value + false + string + + + sortkey + sort key of the disk offering, integer + false + integer + + + state + state of the disk offering + false + string + + + tags + comma-separated list of tags for the disk offering, tags should match with existing storage pool tags + false + 4.15 + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + state + state of the disk offering + string + + + storagetype + the storage type for this disk offering + string + + + suitableforvirtualmachine + Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false + 4.20.0 + boolean + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + removeVirtualMachinesFromKubernetesCluster + Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters. + false + 4.19.0 + + + id + the ID of the Kubernetes cluster + true + uuid + + + virtualmachineids + the IDs of the VMs to remove from the cluster + true + list + list + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the Kubernetes cluster + string + + + false + + + deleteTungstenFabricLogicalRouter + delete Tungsten-Fabric logical router + true + + + logicalrouteruuid + the uuid of Tungsten-Fabric logical router + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + resetVpnConnection + Reset site to site vpn connection + true + + + id + id of vpn connection + true + uuid + + + account + an optional account for connection. Must be used with domainId. + false + string + + + domainid + an optional domainId for connection. If the account parameter is used, domainId must also be used. + false + uuid + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + listKubernetesClusters + Lists Kubernetes clusters + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged + false + 4.19.0 + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the Kubernetes cluster + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned) + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + state of the Kubernetes cluster + false + string + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + createAutoScaleVmGroup + Creates and automatically starts a virtual machine based on a service offering, disk offering, and template. + true + + + lbruleid + the ID of the load balancer rule + true + uuid + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + true + integer + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + true + integer + + + scaledownpolicyids + list of scaledown autoscale policies + true + list + list + + + scaleuppolicyids + list of scaleup autoscale policies + true + list + list + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + true + uuid + + + fordisplay + an optional field, whether to the display the group to the end user or not + false + 4.4 + boolean + + + interval + the frequency in which the performance counters to be collected + false + integer + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + addBaremetalPxePingServer + add a baremetal ping pxe server + true + + + password + Credentials to reach external pxe device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + pingdir + Root directory on PING storage server + true + string + + + pingstorageserverip + PING storage server ip + true + string + + + pxeservertype + type of pxe device + true + string + + + tftpdir + Tftp root directory of PXE server + true + string + + + url + URL of the external pxe device + true + string + + + username + Credentials to reach external pxe device + true + string + + + pingcifspassword + Password of PING storage server + false + string + + + pingcifsusername + Username of PING storage server + false + string + + + podid + Pod Id + false + uuid + + + + + pingdir + Root directory on PING storage server + string + + + pingstorageserverip + PING storage server ip + string + + + tftpdir + Tftp root directory of PXE server + string + + + false + + + changeBgpPeersForVpc + Change the BGP peers for a VPC. + true + 4.20.0 + + + vpcid + UUID of the VPC which the Bgp Peers are associated to. + true + uuid + + + bgppeerids + Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked. + false + list + list + + + + + id + id of the bgp peer + string + + + account + the account of the bgp peer + string + + + asnumber + AS number of bgp peer + long + + + created + date when this bgp peer was created. + date + + + details + additional key/value details of the bgp peer + map + + + domain + the domain name of the bgp peer + string + + + domainid + the domain ID of the bgp peer + string + + + ip6address + IPv6 address of bgp peer + string + + + ipaddress + IPv4 address of bgp peer + string + + + password + password of bgp peer + string + + + project + the project name of the bgp peer + string + + + projectid + the project id of the bgp peer + string + + + zoneid + id of zone to which the bgp peer belongs to. + string + + + zonename + name of zone to which the bgp peer belongs to. + string + + + false + + + deleteLoadBalancerRule + Deletes a load balancer rule. + true + + + id + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listPortableIpRanges + list portable IP ranges + false + + + id + Id of the portable ip range + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + regionid + Id of a Region + false + integer + + + + + id + portable IP range ID + string + + + endip + the end ip of the portable IP range + string + + + gateway + the gateway of the VLAN IP range + string + + + netmask + the netmask of the VLAN IP range + string + + + regionid + Region Id in which portable ip range is provisioned + integer + + + startip + the start ip of the portable IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + portableipaddress(*) + List of portable IP and association with zone/network/vpc details that are part of GSLB rule + + + accountid + the account ID the portable IP address is associated with + string + + + allocated + date the portal IP address was acquired + date + + + domainid + the domain ID the portable IP address is associated with + string + + + ipaddress + public IP address + string + + + networkid + the ID of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + regionid + Region Id in which global load balancer is created + integer + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing and Free + string + + + vpcid + VPC the ip belongs to + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + list + + + false + + + getVirtualMachineUserData + Returns user data associated with the VM + false + 4.4 + + + virtualmachineid + The ID of the virtual machine + true + uuid + + + + + userdata + Base64 encoded VM user data + string + + + virtualmachineid + the ID of the virtual machine + string + + + false + + + createNetworkPermissions + Updates network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + accountids + a comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + accounts + a comma delimited list of accounts within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + projectids + a comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaTariffUpdate + Update the tariff plan for a resource + false + 4.7.0 + + + name + Quota tariff's name + true + 4.18.0.0 + string + + + activationrule + Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule. + false + 4.18.0.0 + string + + + description + Quota tariff's description. Inform empty to remove the description. + false + 4.18.0.0 + string + + + enddate + The end date of the quota tariff. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone. + false + 4.18.0.0 + date + + + position + Position in the execution sequence for tariffs of the same type + false + 4.20.0.0 + integer + + + startdate + DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + usagetype + DEPRECATED. Integer value for the usage type of the resource + false + integer + + + value + The quota tariff value of the resource as per the default unit. + false + double + + + + + id + the ID of the tariff + string + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + position + position in the execution sequence for tariffs of the same type + integer + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + false + + + addIpToNic + Assigns secondary IP to NIC + true + + + nicid + the ID of the nic to which you want to assign private IP + true + uuid + + + ipaddress + Secondary IP Address + false + string + + + + + id + the ID of the secondary private IP addr + string + + + ipaddress + Secondary IP address + string + + + networkid + the ID of the network + string + + + nicid + the ID of the nic + string + + + secondaryip + the list of Secondary ipv4 addr of nic + list + + + virtualmachineid + the ID of the vm + string + + + false + + + disableStaticNat + Disables static rule for given IP address + true + + + ipaddressid + the public IP address ID for which static NAT feature is being disabled + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteUcsManager + Delete a Ucs manager + false + + + ucsmanagerid + ucs manager id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteResourceIcon + deletes the resource icon from the specified resource(s) + false + 4.16.0.0 + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteHost + Deletes a host. + false + + + id + the host ID + true + uuid + + + forced + Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped + false + boolean + + + forcedestroylocalstorage + Force destroy local storage on this host. All VMs created on this local storage will be destroyed + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listCapabilities + Lists capabilities + false + + + + allowusercreateprojects + true if regular user is allowed to create projects + boolean + + + allowuserexpungerecovervm + true if the user can recover and expunge virtualmachines, false otherwise + 4.6.0 + boolean + + + allowuserexpungerecovervolume + true if the user can recover and expunge volumes, false otherwise + 4.14.0 + boolean + + + allowuserforcestopvm + true if users are allowed to force stop a vm, false otherwise + 4.20.0 + boolean + + + allowuserviewalldomainaccounts + true if users can see all accounts within the same domain, false otherwise + boolean + + + allowuserviewdestroyedvm + true if the user is allowed to view destroyed virtualmachines, false otherwise + 4.6.0 + boolean + + + apilimitinterval + time interval (in seconds) to reset api count + integer + + + apilimitmax + Max allowed number of api requests within the specified interval + integer + + + cloudstackversion + version of the cloud stack + string + + + customdiskofferingmaxsize + maximum size that can be specified when create disk from disk offering with custom size + long + + + customdiskofferingminsize + minimum size that can be specified when create disk from disk offering with custom size + long + + + customhypervisordisplayname + Display name for custom hypervisor + 4.19.0 + string + + + defaultuipagesize + default page size in the UI for various views, value set in the configurations + 4.15.2 + long + + + dynamicrolesenabled + true if dynamic role-based api checker is enabled, false otherwise + boolean + + + instancesdisksstatsretentionenabled + true if stats are retained for instance disks otherwise false + 4.18.0 + boolean + + + instancesdisksstatsretentiontime + the retention time for Instances disks stats + 4.18.0 + integer + + + instancesstatsretentiontime + the retention time for Instances stats + 4.18.0 + integer + + + instancesstatsuseronly + true if stats are collected only for user instances, false if system instance stats are also collected + 4.18.0 + boolean + + + kubernetesclusterexperimentalfeaturesenabled + true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise + boolean + + + kubernetesserviceenabled + true if Kubernetes Service plugin is enabled, false otherwise + boolean + + + kvmsnapshotenabled + true if snapshot is supported for KVM host, false otherwise + boolean + + + projectinviterequired + If invitation confirmation is required when add account to project + boolean + + + regionsecondaryenabled + true if region wide secondary is enabled, false otherwise + boolean + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + sharedfsvmmincpucount + the min CPU count for the service offering used by the shared filesystem instance + 4.20.0 + integer + + + sharedfsvmminramsize + the min Ram size for the service offering used by the shared filesystem instance + 4.20.0 + integer + + + supportELB + true if region supports elastic load balancer on basic zones + string + + + userpublictemplateenabled + true if user and domain admins can set templates to be shared, false otherwise + boolean + + + false + + + releaseDedicatedZone + Release dedication of zone + true + + + zoneid + the ID of the Zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateNetworkServiceProvider + Updates a network serviceProvider of a physical network + true + 3.0.0 + + + id + network service provider id + true + uuid + + + servicelist + the list of services to be enabled for this physical network service provider + false + list + list + + + state + Enabled/Disabled/Shutdown the physical network service provider + false + string + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + checkVolume + Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only + true + 4.19.1 + + + id + The ID of the volume + true + uuid + + + repair + parameter to repair the volume, leaks or all are the possible values + false + string + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listManagementServersMetrics + Lists Management Server metrics + false + 4.17.0 + + + id + the id of the management server + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the management server + false + string + + + page + false + integer + + + pagesize + false + integer + + + system + include system level stats + false + boolean + + + + + agentcount + the number of agents this Management Server is responsible for + integer + + + availableprocessors + the number of processors available to the JVM + integer + + + collectiontime + the time these statistics were collected + date + + + cpuload + the current cpu load + string + + + dbislocal + the system is running against a local database + boolean + + + heapmemorytotal + the amount of memory allocated to this Management Server + long + + + heapmemoryused + the amount of memory used by this Management Server + long + + + loginfo + the log files and their usage on disk + string + + + sessions + the number of client sessions active on this Management Server + long + + + systemcycleusage + the system load for user, and system processes and the system idle cycles + long[] + + + systemloadaverages + the load averages for 1 5 and 15 minutes + double[] + + + systemmemoryfree + Free system memory + string + + + systemmemorytotal + Total system memory + string + + + systemmemoryused + Amount of memory used + string + + + systemmemoryvirtualsize + Virtual size of the fully loaded process + string + + + systemtotalcpucycles + the total system cpu capacity + double + + + threadsblockedcount + The number of blocked threads + integer + + + threadsdaemoncount + The number of daemon threads + integer + + + threadsrunnablecount + The number of runnable threads + integer + + + threadsteminatedcount + The number of terminated threads + integer + + + threadstotalcount + The number of threads + integer + + + threadswaitingcount + The number of waiting threads + integer + + + usageislocal + the system has a usage server running locally + boolean + + + false + + + listInstanceGroups + Lists vm groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list instance groups by ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list instance groups by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + domainpath + path of the Domain the instance group belongs to + 4.19.2.0 + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + removeFromLoadBalancerRule + Removes a virtual machine or a list of virtual machines from a load balancer rule. + true + + + id + The ID of the load balancer rule + true + uuid + + + virtualmachineids + the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3) + false + list + list + + + vmidipmap + VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75 + false + map + 4.4 + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createStaticRoute + Creates a static route + true + + + cidr + static route cidr + true + string + + + gatewayid + the gateway id we are creating static route for + true + uuid + + + + + id + the ID of static route + string + + + account + the account associated with the static route + string + + + cidr + static route CIDR + string + + + domain + the domain associated with the static route + string + + + domainid + the ID of the domain associated with the static route + string + + + domainpath + the domain path associated with the static route + 4.19.2.0 + string + + + gatewayid + VPC gateway the route is created for + string + + + project + the project name of the static route + string + + + projectid + the project id of the static route + string + + + state + the state of the static route + string + + + vpcid + VPC the static route belongs to + string + + + tags(*) + the list of resource tags associated with static route + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deletePrivateGateway + Deletes a Private gateway + true + + + id + the ID of the private gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateDomain + Updates a domain with a new name + false + + + id + ID of domain to update + true + uuid + + + name + updates domain with this name + false + string + + + networkdomain + Network domain for the domain's networks; empty string will update domainName with NULL value + false + string + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + taggedresources + The tagged resource limit and count for the domain + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + disableAutoScaleVmGroup + Disables an AutoScale Vm Group + true + + + id + the ID of the autoscale group + true + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + createSnapshotPolicy + Creates a snapshot policy for the account. + false + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + maxsnaps + maximum number of snapshots to retain + true + integer + + + schedule + time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + true + string + + + volumeid + the ID of the disk volume + true + uuid + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + tags + Map of tags (key/value pairs) + false + map + map + + + zoneids + A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present. + false + list + list + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + zone + The list of zones in which snapshot backup is scheduled + 4.19.0 + set + + + false + + + disableHAForZone + Disables HA for a zone + true + 4.11 + + + zoneid + ID of the zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + unmanageVolume + Unmanage a volume on storage pool. + true + 4.19.1 + + + id + The ID of the volume to unmanage + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSystemVms + List system virtual machines. + false + + + hostid + the host ID of the system VM + false + uuid + + + id + the ID of the system VM + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the system VM + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the system VM + false + uuid + + + state + the state of the system VM + false + string + + + storageid + the storage ID where vm's volumes belong to + false + 3.0.1 + uuid + + + systemvmtype + the system VM type. Possible types are "consoleproxy" and "secondarystoragevm". + false + string + + + zoneid + the Zone ID of the system VM + false + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + createRolePermission + Adds an API permission to a role + false + 4.9.0 + + + permission + The rule permission, allow or deny. Default: deny. + true + string + + + roleid + ID of the role + true + uuid + + + rule + The API name or wildcard rule such as list* + true + string + + + description + The description of the role permission + false + string + + + + + id + the ID of the role permission + string + + + roleid + the ID of the role to which the role permission belongs + string + + + rolename + the name of the role to which the role permission belongs + string + + + false + + + replaceNetworkACLList + Replaces ACL associated with a network or private gateway + true + + + aclid + the ID of the network ACL + true + uuid + + + gatewayid + the ID of the private gateway + false + uuid + + + networkid + the ID of the network + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + detachVolume + Detaches a disk volume from a virtual machine. + true + + + deviceid + the device ID on the virtual machine where volume is detached from + false + long + + + id + the ID of the disk volume + false + uuid + + + virtualmachineid + the ID of the virtual machine where the volume is detached from + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTungstenFabricAddressGroup + list Tungsten-Fabric address group + false + + + addressgroupuuid + the uuid of Tungsten-Fabric address group + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + ipprefix + Tungsten-Fabric address group ip prefix + string + + + ipprefixlen + Tungsten-Fabric address group ip prefix length + int + + + name + Tungsten-Fabric address group name + string + + + uuid + Tungsten-Fabric address group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listLdapUsers + Lists LDAP Users according to the specifications from the user request. + false + 4.2.0 + + + domainid + linked domain + false + uuid + + + keyword + List by keyword + false + string + + + listtype + Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter + false + string + + + page + false + integer + + + pagesize + false + integer + + + userfilter + Determines what type of filter is applied on the list of users returned from LDAP. + valid values are + 'NoFilter' no filtering is done, + 'LocalDomain' users already in the current or requested domain will be filtered out of the result list, + 'AnyDomain' users that already exist anywhere in cloudstack will be filtered out, and + 'PotentialImport' all users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource + false + 4.13 + string + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + enableOutOfBandManagementForZone + Enables out-of-band management for a zone + true + 4.9.0 + + + zoneid + the ID of the zone + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + createVMSchedule + Create VM Schedule + false + 4.19.0 + + + action + Action to take on the VM (start/stop/reboot/force_stop/force_reboot). + true + string + + + schedule + Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month' + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + description + Description of the schedule + false + string + + + enabled + Enable VM schedule. Defaults to true + false + boolean + + + enddate + end date after which the schedule becomes inactiveUse format "yyyy-MM-dd hh:mm:ss") + false + date + + + startdate + start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of VM schedule + string + + + action + Action + action + + + created + Date when the schedule was created + date + + + description + Description of VM schedule + string + + + enabled + VM schedule is enabled + boolean + + + enddate + Date after which the schedule becomes inactive + date + + + schedule + Cron formatted VM schedule + string + + + startdate + Date from which the schedule is active + date + + + timezone + Timezone of the schedule + string + + + virtualmachineid + ID of virtual machine + string + + + false + + + listIpForwardingRules + List the IP forwarding rules + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + list the rule belonging to this public IP address + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + virtualmachineid + Lists all rules applied to the specified VM. + false + uuid + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createSnapshot + Creates an instant snapshot of a volume. + true + + + volumeid + The ID of the disk volume + true + uuid + + + account + The account of the snapshot. The account parameter must be used with the domainId parameter. + false + string + + + asyncbackup + asynchronous backup if true + false + boolean + + + domainid + The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain. + false + uuid + + + locationtype + Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'. + false + string + + + name + the name of the snapshot + false + string + + + policyid + policy id of the snapshot, if this is null, then use MANUAL_POLICY. + false + uuid + + + quiescevm + quiesce vm if true + false + boolean + + + tags + Map of tags (key/value pairs) + false + map + map + + + zoneids + A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. + false + list + 4.19.0 + list + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listStoragePoolsMetrics + Lists storage pool metrics + false + 4.9.3 + + + clusterid + list storage pools belongig to the specific cluster + false + uuid + + + hostid + host ID of the storage pools + false + uuid + + + id + the ID of the storage pool + false + uuid + + + ipaddress + the IP address for the storage pool + false + string + + + keyword + List by keyword + false + string + + + name + the name of the storage pool + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the storage pool path + false + string + + + podid + the Pod ID for the storage pool + false + uuid + + + scope + the scope of the storage pool + false + string + + + status + the status of the storage pool + false + string + + + storagecustomstats + If true, lists the custom stats of the storage pool + false + 4.18.1 + boolean + + + zoneid + the Zone ID for the storage pool + false + uuid + + + + + disksizeallocatedgb + disk size allocated in GiB + string + + + disksizetotalgb + disk size in GiB + string + + + disksizeunallocatedgb + disk size unallocated in GiB + string + + + disksizeusedgb + disk size used in GiB + string + + + storageallocateddisablethreshold + storage allocated disable threshold exceeded + boolean + + + storageallocatedthreshold + storage allocated notification threshold exceeded + boolean + + + storageusagedisablethreshold + storage usage disable threshold exceeded + boolean + + + storageusagethreshold + storage usage notification threshold exceeded + boolean + + + false + + + createSSHKeyPair + Create a new keypair and returns the private key + false + + + name + Name of the keypair + true + string + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the ssh key. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the ssh key + false + uuid + + + + + privatekey + Private key + string + + + false + + + deleteBackupOffering + Deletes a backup offering + false + 4.14.0 + + + id + ID of the backup offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricServiceGroup + list Tungsten-Fabric service group + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + servicegroupuuid + the uuid of Tungsten-Fabric service group + false + string + + + zoneid + the ID of zone + false + uuid + + + + + endport + Tungsten-Fabric service group end port + int + + + name + Tungsten-Fabric service group name + string + + + protocol + Tungsten-Fabric service group protocol + string + + + startport + Tungsten-Fabric service group start port + int + + + uuid + Tungsten-Fabric service group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + authorizeSecurityGroupEgress + Authorizes a particular egress rule for this security group + true + 3.0.0 + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + cidrlist + the cidr list associated. Multiple entries must be separated by a single comma character (,). + false + list + list + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + endport + end port for this egress rule + false + integer + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + projectid + an optional project of the security group + false + uuid + + + protocol + TCP is default. UDP is the other supported protocol + false + string + + + securitygroupid + The ID of the security group. Mutually exclusive with securityGroupName parameter + false + uuid + + + securitygroupname + The name of the security group. Mutually exclusive with securityGroupId parameter + false + string + + + startport + start port for this egress rule + false + integer + + + usersecuritygrouplist + user to security group mapping + false + map + map + + + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listStoragePools + Lists storage pools. + false + + + clusterid + list storage pools belongig to the specific cluster + false + uuid + + + hostid + host ID of the storage pools + false + uuid + + + id + the ID of the storage pool + false + uuid + + + ipaddress + the IP address for the storage pool + false + string + + + keyword + List by keyword + false + string + + + name + the name of the storage pool + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the storage pool path + false + string + + + podid + the Pod ID for the storage pool + false + uuid + + + scope + the scope of the storage pool + false + string + + + status + the status of the storage pool + false + string + + + storagecustomstats + If true, lists the custom stats of the storage pool + false + 4.18.1 + boolean + + + zoneid + the Zone ID for the storage pool + false + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + findHostsForMigration + Find hosts suitable for migrating a virtual machine. + false + + + virtualmachineid + find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the host + string + + + averageload + the cpu average load on the host + long + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpunumber + the CPU number of the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + events + events available for the host + string + + + explicithosttags + comma-separated list of explicit host tags for the host + 4.20.0 + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + implicithosttags + comma-separated list of implicit host tags for the host + 4.20.0 + string + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + long + + + memoryallocated + the amount of the host's memory currently allocated + string + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + requiresStorageMotion + true if migrating a vm to this host requires storage motion, false otherwise + boolean + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + false + + + enableCiscoNexusVSM + Enable a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be enabled + true + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + updateHypervisorCapabilities + Updates a hypervisor capabilities. + false + 3.0.0 + + + hypervisor + the hypervisor for which the hypervisor capabilities are to be updated + false + 4.19.1 + string + + + hypervisorversion + the hypervisor version for which the hypervisor capabilities are to be updated + false + 4.19.1 + string + + + id + ID of the hypervisor capability + false + uuid + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached to a VM for this hypervisor. + false + 4.16.0 + integer + + + maxguestslimit + the max number of Guest VMs per host for this hypervisor. + false + long + + + maxhostspercluster + the maximum number of the hypervisor hosts per cluster + false + 4.16.0 + integer + + + securitygroupenabled + set true to enable security group for this hypervisor. + false + boolean + + + storagemotionenabled + set true to enable storage motion support for this hypervisor + false + 4.16.0 + boolean + + + vmsnapshotenabled + set true to enable VM snapshots for this hypervisor + false + 4.16.0 + boolean + + + + + id + the ID of the hypervisor capabilities row + string + + + hypervisor + the hypervisor type + string + + + hypervisorversion + the hypervisor version + string + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached for this hypervisor + integer + + + maxguestslimit + the maximum number of guest vms recommended for this hypervisor + long + + + maxhostspercluster + the maximum number of Hosts per cluster for this hypervisor + integer + + + securitygroupenabled + true if security group is supported + boolean + + + storagemotionenabled + true if storage motion is supported + boolean + + + vmsnapshotenabled + true if VM snapshots are enabled for this hypervisor + boolean + + + false + + + isAccountAllowedToCreateOfferingsWithTags + Return true if the specified account is allowed to create offerings with tags. + false + + + id + Account UUID + false + uuid + + + + + isallowed + is domain admin allowed to create offerings with tags + boolean + + + false + + + addNicToVirtualMachine + Adds VM to specified network by creating a NIC + true + + + networkid + Network ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + dhcpoptions + DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com + false + map + map + + + ipaddress + IP Address for the new network + false + string + + + macaddress + Mac Address for the new network + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + getSPMetadata + Returns SAML2 CloudStack Service Provider MetaData + false + + + + metadata + The Metadata XML + string + + + false + + + listStaticRoutes + Lists all static routes + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + gatewayid + list static routes by gateway id + false + uuid + + + id + list static route by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + list static routes by state + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vpcid + list static routes by vpc id + false + uuid + + + + + id + the ID of static route + string + + + account + the account associated with the static route + string + + + cidr + static route CIDR + string + + + domain + the domain associated with the static route + string + + + domainid + the ID of the domain associated with the static route + string + + + domainpath + the domain path associated with the static route + 4.19.2.0 + string + + + gatewayid + VPC gateway the route is created for + string + + + project + the project name of the static route + string + + + projectid + the project id of the static route + string + + + state + the state of the static route + string + + + vpcid + VPC the static route belongs to + string + + + tags(*) + the list of resource tags associated with static route + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listPublicIpAddresses + Lists all public ip addresses + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + allocatedonly + limits search results to allocated public IP addresses + false + boolean + + + associatednetworkid + lists all public IP addresses associated to the network specified + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + forloadbalancing + list only IPs used for load balancing + false + boolean + + + forsystemvms + true if range is dedicated for system VMs + false + 4.20.0 + boolean + + + forvirtualnetwork + the virtual network for the IP address + false + boolean + + + id + lists IP address by ID + false + uuid + + + ipaddress + lists the specified IP address + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issourcenat + list only source NAT IP addresses + false + boolean + + + isstaticnat + list only static NAT IP addresses + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + lists all public IP addresses by source network ID + false + 4.13.0 + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + lists all public IP addresses by physical network ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + state + lists all public IP addresses by state + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vlanid + lists all public IP addresses by VLAN ID + false + uuid + + + vpcid + List IPs belonging to the VPC + false + uuid + + + zoneid + lists all public IP addresses by zone ID + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forsystemvms + true if range is dedicated for System VMs + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listOpenDaylightControllers + Lists OpenDyalight controllers + false + + + id + the ID of a OpenDaylight Controller + false + uuid + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + addBigSwitchBcfDevice + Adds a BigSwitch BCF Controller device + true + 4.6.0 + + + hostname + Hostname of ip address of the BigSwitch BCF Controller. + true + string + + + nat + NAT support of the BigSwitch BCF Controller. + true + boolean + + + password + Password of the BigSwitch BCF Controller. + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Username of the BigSwitch BCF Controller. + true + string + + + + + bcfdeviceid + device id of the BigSwitch BCF Controller + string + + + bigswitchdevicename + device name + string + + + hostname + the controller Ip address + string + + + nat + NAT support + boolean + + + password + the controller password + string + + + physicalnetworkid + the physical network to which this BigSwitch BCF segment belongs to + string + + + provider + name of the provider + string + + + username + the controller username + string + + + false + + + updateDefaultNicForVirtualMachine + Changes the default NIC on a VM + true + + + nicid + NIC ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + generateClusterDrsPlan + Generate DRS plan for a cluster + false + 4.19.0 + + + id + the ID of the Cluster + true + uuid + + + migrations + Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting + false + integer + + + + + id + unique ID of the drs plan for cluster + string + + + clusterid + Id of the cluster + string + + + eventid + Start event Id of the DRS Plan + string + + + migrations + List of migrations + list + + + status + Status of DRS Plan + status + + + type + Type of DRS Plan (Automated or Manual)) + type + + + false + + + createSharedFileSystem + Create a new Shared File System of specified size and disk offering, attached to the given network + true + 4.20.0 + + + diskofferingid + the disk offering to use for the underlying storage. This will define the size and other specifications like encryption and qos for the shared filesystem. + true + uuid + + + filesystem + the filesystem format (XFS / EXT4) which will be installed on the shared filesystem. + true + string + + + name + the name of the shared filesystem. + true + string + + + networkid + network to attach the shared filesystem to + true + uuid + + + serviceofferingid + the service offering to use for the shared filesystem instance hosting the data. The offering should be HA enabled and the cpu count and memory size should be greater than equal to sharedfsvm.min.cpu.count and sharedfsvm.min.ram.size respectively + true + uuid + + + zoneid + the zone id. + true + uuid + + + account + the account associated with the shared filesystem. Must be used with the domainId parameter. + false + string + + + description + the description for the shared filesystem. + false + string + + + domainid + the domain ID associated with the shared filesystem. If used with the account parameter returns the shared filesystem associated with the account for the specified domain.If account is NOT provided then the shared filesystem will be assigned to the caller account and domain. + false + uuid + + + maxiops + max iops + false + long + + + miniops + min iops + false + long + + + projectid + the project associated with the shared filesystem. Mutually exclusive with account parameter + false + uuid + + + provider + the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API. + false + string + + + size + the size of the shared filesystem in GiB + false + long + + + + + id + ID of the shared filesystem + string + + + account + the account associated with the shared filesystem + string + + + description + description of the shared filesystem + string + + + diskioread + the read (IO) of disk on the shared filesystem + long + + + diskiowrite + the write (IO) of disk on the shared filesystem + long + + + diskkbsread + the shared filesystem's disk read in KiB + long + + + diskkbswrite + the shared filesystem's disk write in KiB + long + + + diskofferingdisplaytext + disk offering display text for the shared filesystem + string + + + diskofferingid + disk offering ID for the shared filesystem + string + + + diskofferingname + disk offering for the shared filesystem + string + + + domain + the domain associated with the shared filesystem + string + + + domainid + the ID of the domain associated with the shared filesystem + string + + + domainpath + path of the domain to which the shared filesystem + string + + + filesystem + the filesystem format + string + + + iscustomdiskoffering + disk offering for the shared filesystem has custom size + boolean + + + name + name of the shared filesystem + string + + + networkid + Network ID of the shared filesystem + string + + + networkname + Network name of the shared filesystem + string + + + path + path to mount the shared filesystem + string + + + physicalsize + the bytes actually consumed on disk + long + + + project + the project name of the shared filesystem + string + + + projectid + the project ID of the shared filesystem + string + + + provider + the shared filesystem provider + string + + + provisioningtype + provisioning type used in the shared filesystem + string + + + serviceofferingid + service offering ID for the shared filesystem + string + + + serviceofferingname + service offering for the shared filesystem + string + + + size + size of the shared filesystem + long + + + sizegb + size of the shared filesystem in GiB + string + + + state + the state of the shared filesystem + string + + + storage + name of the storage pool hosting the data volume + string + + + storageid + ID of the storage pool hosting the data volume + string + + + utilization + the disk utilization + string + + + virtualmachineid + ID of the storage fs vm + string + + + virtualsize + the bytes allocated + long + + + vmstate + ID of the storage fs vm + string + + + volumeid + ID of the storage fs data volume + string + + + volumename + name of the storage fs data volume + string + + + zoneid + ID of the availability zone + string + + + zonename + Name of the availability zone + string + + + nic(*) + the list of nics associated with the shared filesystem + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + list + + + false + + + deleteUser + Deletes a user for an account + false + + + id + id of the user to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + issueOutOfBandManagementPowerAction + Initiates the specified power action to the host's out-of-band management interface + true + 4.9.0 + + + action + out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS + true + string + + + hostid + the ID of the host + true + uuid + + + timeout + optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting + false + long + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + deleteNetworkDevice + Deletes network device. + false + + + id + Id of network device to delete + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateImageStore + Updates image store read-only status + false + 4.15.0 + + + id + Image Store UUID + true + uuid + + + capacitybytes + The number of bytes CloudStack can use on this image storage. + NOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage. + false + long + + + name + The new name for the Image Store. + false + string + + + readonly + If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration + false + boolean + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + assignToLoadBalancerRule + Assigns virtual machine or a list of virtual machines to a load balancer rule. + true + + + id + the ID of the load balancer rule + true + uuid + + + virtualmachineids + the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3) + false + list + list + + + vmidipmap + VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75 + false + map + 4.4 + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + archiveAlerts + Archive one or more alerts. + false + + + enddate + end date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the alerts + false + list + list + + + startdate + start date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + archive by alert type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAsyncJobs + Lists all pending asynchronous jobs for the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + managementserverid + The id of the management server + false + 4.19 + uuid + + + page + false + integer + + + pagesize + false + integer + + + startdate + The start date of the async job (use format "yyyy-MM-dd'T'HH:mm:ss'+'SSSS") + false + date + + + + + account + the account that executed the async command + string + + + accountid + the account id that executed the async command + string + + + cmd + the async command executed + string + + + completed + the completed date of the job + date + + + created + the created date of the job + date + + + domainid + the domain id that executed the async command + string + + + domainpath + the domain that executed the async command + string + + + jobinstanceid + the unique ID of the instance/entity object related to the job + string + + + jobinstancetype + the instance/entity object related to the job + string + + + jobprocstatus + the progress information of the PENDING job + integer + + + jobresult + the result reason + responseobject + + + jobresultcode + the result code for the job + integer + + + jobresulttype + the result type + string + + + jobstatus + the current job status-should be 0 for PENDING + integer + + + managementserverid + the msid of the management server on which the job is running + 4.19 + long + + + userid + the user that executed the async command + string + + + jobid + the ID of the async job + + + false + + + deleteCiscoVnmcResource + Deletes a Cisco Vnmc controller + false + + + resourceid + Cisco Vnmc resource ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createSecondaryStorageSelector + Creates a secondary storage selector, described by the heuristic rule. + false + 4.19.0 + + + description + The description of the heuristic rule. + true + string + + + heuristicrule + The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID. + true + string + + + name + The name identifying the heuristic rule. + true + string + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + true + string + + + zoneid + The zone in which the heuristic rule will be applied. + true + uuid + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + addBrocadeVcsDevice + Adds a Brocade VCS Switch + true + + + hostname + Hostname of ip address of the Brocade VCS Switch. + true + string + + + password + Credentials to access the Brocade VCS Switch API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Credentials to access the Brocade VCS Switch API + true + string + + + + + brocadedevicename + device name + string + + + hostname + the principal switch Ip address + string + + + physicalnetworkid + the physical Network to which this Brocade VCS belongs to + string + + + provider + name of the provider + string + + + vcsdeviceid + device id of the Brocade Vcs + string + + + false + + + deleteTags + Deleting resource tag(s) + true + 4.0.0 + + + resourceids + Delete tags for resource id(s) + true + list + list + + + resourcetype + Delete tag by resource type + true + string + + + tags + Delete tags matching key/value pairs + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricTagType + create Tungsten-Fabric tag type + true + + + name + Tungsten-Fabric tag type name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric tag type name + string + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + login + Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired. + false + + + password + Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Username + true + string + + + domain + Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed. + false + string + + + domainId + The id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precedence. + false + long + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + restartNetwork + Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules + true + + + id + The ID of the network to restart. + true + uuid + + + cleanup + If cleanup old network elements + false + boolean + + + livepatch + Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false. + false + 4.17.0 + boolean + + + makeredundant + Turn the network into a network with redundant routers. + false + 4.11.1 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listHypervisorCapabilities + Lists all hypervisor capabilities. + false + 3.0.0 + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + ID of the hypervisor capability + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the hypervisor capabilities row + string + + + hypervisor + the hypervisor type + string + + + hypervisorversion + the hypervisor version + string + + + maxdatavolumeslimit + the maximum number of Data Volumes that can be attached for this hypervisor + integer + + + maxguestslimit + the maximum number of guest vms recommended for this hypervisor + long + + + maxhostspercluster + the maximum number of Hosts per cluster for this hypervisor + integer + + + securitygroupenabled + true if security group is supported + boolean + + + storagemotionenabled + true if storage motion is supported + boolean + + + vmsnapshotenabled + true if VM snapshots are enabled for this hypervisor + boolean + + + false + + + deleteProjectRole + Delete Project roles in CloudStack + false + 4.15.0 + + + id + ID of the project role to be deleted + true + uuid + + + projectid + ID of the project from where the role is to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaPresetVariablesList + List the preset variables available for using in the Quota tariff activation rules given the usage type. + false + 4.20 + + + usagetype + The usage type for which the preset variables will be retrieved. + true + integer + + + + + description + description + string + + + variable + variable + string + + + false + + + quotaBalance + Create a quota balance statement + false + 4.7.0 + + + account + Account Id for which statement needs to be generated + true + string + + + domainid + If domain Id is given and the caller is domain admin then the statement is generated for domain. + true + uuid + + + accountid + List usage records for the specified account + false + uuid + + + enddate + End of the period of the Quota balance.The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone. + false + date + + + startdate + Start of the period of the Quota balance. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "00:00:00"). If the recommended format is not used, the date will be considered in the server timezone. + false + date + + + + + account + account name + string + + + accountid + account id + long + + + domain + domain id + long + + + name + usage type name + string + + + quota + quota consumed + bigdecimal + + + type + usage type + int + + + unit + usage unit + string + + + false + + + getSolidFireAccountId + Get SolidFire Account ID + false + + + accountid + CloudStack Account UUID + true + string + + + storageid + Storage Pool UUID + true + string + + + + + solidFireAccountId + SolidFire Account ID + long + + + false + + + listRolePermissions + Lists role permissions + false + 4.9.0 + + + roleid + ID of the role + false + uuid + + + + + id + the ID of the role permission + string + + + roleid + the ID of the role to which the role permission belongs + string + + + rolename + the name of the role to which the role permission belongs + string + + + false + + + listDedicatedGuestVlanRanges + Lists dedicated guest vlan ranges + false + + + account + the account with which the guest VLAN range is associated. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain. + false + uuid + + + guestvlanrange + the dedicated guest vlan range + false + string + + + id + list dedicated guest vlan ranges by id + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + physical network id of the guest VLAN range + false + uuid + + + projectid + project who will own the guest VLAN range + false + uuid + + + zoneid + zone of the guest VLAN range + false + uuid + + + + + id + the ID of the guest VLAN range + string + + + account + the account of the guest VLAN range + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + domainpath + path of the domain to which the guest VLAN range belongs + 4.19.2.0 + string + + + guestvlanrange + the guest VLAN range + string + + + physicalnetworkid + the physical network of the guest vlan range + long + + + project + the project name of the guest vlan range + string + + + projectid + the project id of the guest vlan range + string + + + zoneid + the zone of the guest vlan range + long + + + false + + + listNetworkACLs + Lists all network ACL items + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + aclid + list network ACL items by ACL ID + false + uuid + + + action + list network ACL items by action + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists network ACL Item with the specified ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list network ACL items by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + protocol + list network ACL items by protocol + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + list network ACL items by traffic type - ingress or egress + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + copyTemplate + Copies a template from one zone to another. + true + + + id + Template ID. + true + uuid + + + destzoneid + ID of the zone the template is being copied to. + false + uuid + + + destzoneids + 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. + false + list + list + + + sourcezoneid + 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. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listNiciraNvpDeviceNetworks + lists network that are using a nicira nvp device + false + + + nvpdeviceid + nicira nvp device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + asnumber + AS NUMBER + 4.20.0 + long + + + asnumberid + UUID of AS NUMBER + 4.20.0 + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + bgppeers + The BGP peers for the network + 4.20.0 + set + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip4routes + The routes for the network to ease adding route in upstream router + 4.20.0 + set + + + ip4routing + The IPv4 routing type of network + 4.20.0 + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The Ipv6 routing type of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteBigSwitchBcfDevice + delete a BigSwitch BCF Controller device + true + 4.6.0 + + + bcfdeviceid + BigSwitch device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listOvsElements + Lists all available ovs elements. + false + + + enabled + list network offerings by enabled state + false + boolean + + + id + list ovs elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list ovs elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the ovs + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + associateUcsProfileToBlade + associate a profile to a blade + true + + + bladeid + blade id + true + uuid + + + profiledn + profile dn + true + string + + + ucsmanagerid + ucs manager id + true + uuid + + + + + id + ucs blade id + string + + + bladedn + ucs blade dn + string + + + hostid + cloudstack host id this blade associates to + string + + + profiledn + associated ucs profile dn + string + + + ucsmanagerid + ucs manager id + string + + + false + + + validateUserTwoFactorAuthenticationCode + Checks the 2FA code for the user. + false + 4.18.0 + + + codefor2fa + two factor authentication code + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateVmwareDc + Updates a VMware datacenter details for a zone + false + 4.12.0 + + + zoneid + The zone ID + true + uuid + + + isrecursive + Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true. + false + boolean + + + name + VMware datacenter name. + false + string + + + password + The password for specified username. + false + string + + + username + The username required to connect to resource. + false + string + + + vcenter + The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + getRouterHealthCheckResults + Starts a router. + false + 4.14.0 + + + routerid + the ID of the router + true + uuid + + + performfreshchecks + if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched + false + boolean + + + + + healthchecks + the id of the router + list + + + routerid + the id of the router + string + + + false + + + listNetscalerControlCenter + list control center + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + id + string + + + ipaddress + ncc_ip + string + + + numretries + num_retries + string + + + username + username + string + + + uuid + uuid + string + + + false + + + deleteAffinityGroup + Deletes affinity group + true + + + account + the account of the affinity group. Must be specified with domain ID + false + string + + + domainid + the domain ID of account owning the affinity group + false + uuid + + + id + The ID of the affinity group. Mutually exclusive with name parameter + false + uuid + + + name + The name of the affinity group. Mutually exclusive with ID parameter + false + string + + + projectid + the project of the affinity group + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addNsxController + Add NSX Controller to CloudStack + false + 4.19.0 + + + edgecluster + Edge Cluster name + true + string + + + name + NSX controller / provider name + true + string + + + nsxproviderhostname + NSX controller hostname / IP address + true + string + + + password + Password to login into NSX controller + true + string + + + tier0gateway + Tier-0 Gateway address + true + string + + + transportzone + Transport Zone controls to which hosts a logical switch can reach + true + string + + + username + Username to log into NSX controller + true + string + + + zoneid + the ID of zone + true + uuid + + + nsxproviderport + NSX controller port + false + string + + + + + edgecluster + The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX + string + + + hostname + NSX controller hostname or IP address + string + + + name + NSX controller name + string + + + nsxprovideruuid + NSX controller ID + string + + + port + NSX controller port + string + + + tier0gateway + The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks + string + + + transportzone + The name of the transport zone. A transport zone controls to which hosts a logical switch can reach + string + + + zoneid + Zone ID to which the NSX controller is associated with + string + + + zonename + Zone name to which the NSX controller is associated with + string + + + false + + + resizeVolume + Resizes a volume + true + + + id + the ID of the disk volume + true + uuid + + + diskofferingid + new disk offering id + false + uuid + + + maxiops + New maximum number of IOPS + false + long + + + miniops + New minimum number of IOPS + false + long + + + shrinkok + Verify OK to Shrink + false + boolean + + + size + New volume size in GB + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteNetworkOffering + Deletes a network offering. + false + 3.0.0 + + + id + the ID of the network offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateStorageNetworkIpRange + Update a Storage network IP range, only allowed when no IPs in this range have been allocated. + true + 3.0.0 + + + id + UUID of storage network ip range + true + uuid + + + endip + the ending IP address + false + string + + + netmask + the netmask for storage network + false + string + + + startip + the beginning IP address + false + string + + + vlan + Optional. the vlan the ip range sits on + false + integer + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + dedicatePod + Dedicates a Pod. + true + + + domainid + the ID of the containing domain + true + uuid + + + podid + the ID of the Pod + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Pod is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the pod + string + + + domainid + the domain ID to which the Pod is dedicated + string + + + podid + the ID of the Pod + string + + + podname + the Name of the Pod + string + + + false + + + synchronizeTungstenFabricData + Synchronize Tungsten-Fabric data + false + + + id + provider id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + purgeExpungedResources + Purge expunged resources + true + 4.20 + + + batchsize + The size of batch used during purging + false + long + + + enddate + The end date range of the expunged resources used for purging (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss") + false + date + + + resourcetype + The type of the resource which need to be purged. Supported types: VirtualMachine + false + string + + + startdate + The start date range of the expunged resources used for purging (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss") + false + date + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + changeOfferingForVolume + Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering + true + 4.17 + + + id + the ID of the volume + true + uuid + + + diskofferingid + new disk offering id + true + uuid + + + automigrate + Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering + false + boolean + + + maxiops + New maximum number of IOPS for the custom disk offering + false + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + long + + + shrinkok + Verify OK to Shrink + false + boolean + + + size + New volume size in GB for the custom disk offering + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteLdapConfiguration + Remove an Ldap Configuration + false + 4.2.0 + + + hostname + Hostname + true + string + + + domainid + linked domain + false + uuid + + + port + port + false + integer + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port the ldap server is running on + int + + + false + + + createProjectRole + Creates a Project role + false + 4.15.0 + + + name + creates a project role with this unique name + true + string + + + projectid + ID of project where role is being created + true + uuid + + + description + The description of the Project role + false + string + + + + + projectid + the id of the project + string + + + false + + + createIpv6FirewallRule + Creates an Ipv6 firewall rule in the given network (the network must not belong to VPC) + true + + + networkid + The network of the VM the Ipv6 firewall rule will be created for + true + uuid + + + protocol + the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + true + string + + + cidrlist + the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + destcidrlist + the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of Ipv6 firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + startport + the starting port of Ipv6 firewall rule + false + integer + + + traffictype + the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + triggerShutdown + Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced + false + 4.19.0 + + + managementserverid + the uuid of the management server + true + uuid + + + + + managementserverid + The id of the management server + long + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + updateNetwork + Updates a network + true + + + id + the ID of the network + true + uuid + + + changecidr + Force update even if CIDR type is different + false + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + false + boolean + + + displaytext + the new display text for the network + false + string + + + dns1 + the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone + false + 4.18.0 + string + + + forced + Setting this to true will cause a forced network update, + false + boolean + + + guestvmcidr + CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR + false + string + + + hideipaddressusage + when true ip address usage for the network will not be exported by the listUsageRecords API + false + boolean + + + ip6dns1 + the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone + false + 4.18.0 + string + + + name + the new name for the network + false + string + + + networkdomain + network domain + false + string + + + networkofferingid + network offering ID + false + uuid + + + privatemtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network + false + 4.19 + string + + + updateinsequence + if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider + false + boolean + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + asnumber + AS NUMBER + 4.20.0 + long + + + asnumberid + UUID of AS NUMBER + 4.20.0 + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + bgppeers + The BGP peers for the network + 4.20.0 + set + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip4routes + The routes for the network to ease adding route in upstream router + 4.20.0 + set + + + ip4routing + The IPv4 routing type of network + 4.20.0 + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The Ipv6 routing type of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listBackups + Lists VM backups + false + 4.14.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + id of the backup + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + virtualmachineid + id of the VM + false + uuid + + + zoneid + list backups by zone id + false + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + date + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + listUsageTypes + List Usage Types + false + + + + id + Usage type ID + integer + + + description + Usage type description + string + + + name + Usage type name + string + + + false + + + deleteNsxController + delete NSX Controller to CloudStack + false + 4.19.0 + + + nsxcontrollerid + NSX Controller ID + true + uuid + + + + + edgecluster + The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX + string + + + hostname + NSX controller hostname or IP address + string + + + name + NSX controller name + string + + + nsxprovideruuid + NSX controller ID + string + + + port + NSX controller port + string + + + tier0gateway + The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks + string + + + transportzone + The name of the transport zone. A transport zone controls to which hosts a logical switch can reach + string + + + zoneid + Zone ID to which the NSX controller is associated with + string + + + zonename + Zone name to which the NSX controller is associated with + string + + + false + + + listBackupProviders + Lists Backup and Recovery providers + false + 4.14.0 + + + name + List Backup and Recovery provider by name + false + string + + + + + description + the description of the CA service provider + string + + + name + the CA service provider name + string + + + false + + + deleteVPC + Deletes a VPC + true + + + id + the ID of the VPC + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateVirtualMachine + Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default + false + 4.16.0 + boolean + + + hostid + Destination Host ID to migrate VM to. + false + uuid + + + storageid + Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteKubernetesSupportedVersion + Deletes a Kubernetes cluster + true + + + id + the ID of the Kubernetes supported version + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBaremetalRct + list baremetal rack configuration + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + id of rct + string + + + url + url + string + + + false + + + listCAProviders + Lists available certificate authority providers in CloudStack + false + 4.11.0 + + + name + List CA service provider by name + false + string + + + + + description + the description of the CA service provider + string + + + name + the CA service provider name + string + + + false + + + deleteVpnCustomerGateway + Delete site to site vpn customer gateway + true + + + id + id of customer gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listPortForwardingRules + Lists all port forwarding rules for an IP address. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the port forwarding services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list port forwarding rules for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + acquirePodIpAddress + Allocates IP addresses in respective Pod of a Zone + false + + + zoneid + the ID of the zone + true + string + + + podid + Pod ID + false + string + + + + + id + the ID of the pod the IP address + long + + + cidr + CIDR of the Pod + string + + + gateway + Gateway for Pod + string + + + hostmac + MAC address of the pod the IP + long + + + ipaddress + Allocated IP address + string + + + nicid + the ID of the nic + long + + + podid + the ID of the pod the IP address belongs to + long + + + false + + + enableOutOfBandManagementForCluster + Enables out-of-band management for a cluster + true + 4.9.0 + + + clusterid + the ID of the cluster + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + updateTemplatePermissions + Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them. + false + + + id + the template ID + true + uuid + + + accounts + a comma delimited list of accounts within caller's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + isextractable + true if the template/iso is extractable, false other wise. Can be set only by root admin + false + boolean + + + isfeatured + true for featured template/iso, false otherwise + false + boolean + + + ispublic + true for public template/iso, false for private templates/isos + false + boolean + + + op + permission operator (add, remove, reset) + false + string + + + projectids + a comma delimited list of projects. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + resetPasswordForVirtualMachine + Resets the password for virtual machine. The virtual machine must be in a "Stopped" state and the template must already support this feature for this command to take effect. [async] + true + + + id + The ID of the virtual machine + true + uuid + + + password + The new password of the virtual machine. If null, a random password will be generated for the VM. + false + 4.19.0 + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listBrocadeVcsDevices + Lists Brocade VCS Switches + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + vcsdeviceid + Brocade VCS switch ID + false + uuid + + + + + brocadedevicename + device name + string + + + hostname + the principal switch Ip address + string + + + physicalnetworkid + the physical Network to which this Brocade VCS belongs to + string + + + provider + name of the provider + string + + + vcsdeviceid + device id of the Brocade Vcs + string + + + false + + + linkDomainToLdap + link an existing cloudstack domain to group or OU in ldap + false + 4.6.0 + + + accounttype + Type of the account to auto import. Specify 0 for user and 2 for domain admin + true + integer + + + domainid + The id of the domain which has to be linked to LDAP. + true + uuid + + + type + type of the ldap name. GROUP or OU + true + string + + + admin + domain admin username in LDAP + false + string + + + ldapdomain + name of the group or OU in LDAP + false + string + + + name + name of the group or OU in LDAP + false + string + + + + + accountid + Domain Admin accountId that is created + string + + + accounttype + Type of the account to auto import + int + + + domainid + id of the Domain which is linked to LDAP + string + + + ldapdomain + name of the group or OU in LDAP which is linked to the domain + string + + + name + name of the group or OU in LDAP which is linked to the domain + string + + + type + type of the name in LDAP which is linked to the domain + string + + + false + + + setupUserTwoFactorAuthentication + Setup the 2FA for the user. + false + 4.18.0 + + + enable + Enabled by default, provide false to disable 2FA + false + boolean + + + provider + two factor authentication code + false + string + + + userid + optional: the id of the user for which 2FA has to be disabled + false + uuid + + + + + id + the user ID + string + + + accountid + the account ID of the user + string + + + secretcode + secret code that needs to be registered with authenticator + string + + + username + the user name + string + + + false + + + listVpnCustomerGateways + Lists site to site vpn customer gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + id of the customer gateway + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + deleteKubernetesCluster + Deletes a Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + cleanup + Destroy attached instances of the ExternalManaged Cluster. Default: false + false + 4.19.0 + boolean + + + expunge + Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false + false + 4.19.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listWebhooks + Lists Webhooks + false + 4.20.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + The ID of the Webhook + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + The name of the Webhook + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + scope + The scope of the Webhook + false + string + + + state + The state of the Webhook + false + string + + + + + id + The ID of the Webhook + string + + + account + The account associated with the Webhook + string + + + created + The date when this Webhook was created + date + + + description + The description of the Webhook + string + + + domain + The name of the domain in which the Webhook exists + string + + + domainid + The ID of the domain in which the Webhook exists + string + + + domainpath + path of the domain to which the Webhook belongs + string + + + name + The name of the Webhook + string + + + payloadurl + The payload URL end point for the Webhook + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + scope + The scope of the Webhook + string + + + secretkey + The secret key for the Webhook + string + + + sslverification + Whether SSL verification is enabled for the Webhook + boolean + + + state + The state of the Webhook + string + + + false + + + listAndSwitchSamlAccount + Lists and switches to other SAML accounts owned by the SAML user + false + + + domainid + Domain uuid + false + uuid + + + userid + User uuid + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createGlobalLoadBalancerRule + Creates a global load balancer rule + true + + + gslbdomainname + domain name for the GSLB service. + true + string + + + gslbservicetype + GSLB service type (tcp, udp, http) + true + string + + + name + name of the load balancer rule + true + string + + + regionid + region where the global load balancer is going to be created. + true + integer + + + account + the account associated with the global load balancer. Must be used with the domainId parameter. + false + string + + + description + the description of the load balancer rule + false + string + + + domainid + the domain ID associated with the load balancer + false + uuid + + + gslblbmethod + load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin' + false + string + + + gslbstickysessionmethodname + session sticky method (sourceip) if not specified defaults to sourceip + false + string + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + deleteNetscalerLoadBalancer + delete a netscaler load balancer device + true + + + lbdeviceid + netscaler load balancer device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAffectedVmsForStorageScopeChange + List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster. + false + 4.19.1 + + + clusterid + the Id of the cluster the scope of the storage pool is being changed to + true + uuid + + + storageid + the Id of the storage pool on which change scope operation is being done + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the VM + string + + + clusterid + the cluster ID for the VM + string + + + clustername + the cluster name for the VM + string + + + hostid + the host ID for the VM + string + + + hostname + the hostname for the VM + string + + + name + the name of the VM + string + + + type + the type of VM + string + + + false + + + listTags + List resource tag(s) + false + 4.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + customer + list by customer name + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + key + list by key + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + list by resource id + false + string + + + resourcetype + list by resource type + false + string + + + value + list by value + false + string + + + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + false + + + createVirtualRouterElement + Create a virtual router element. + true + + + nspid + the network service provider ID of the virtual router element + true + uuid + + + providertype + The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + createVPC + Creates a VPC + true + + + name + the name of the VPC + true + string + + + vpcofferingid + the ID of the VPC offering + true + uuid + + + zoneid + the ID of the availability zone + true + uuid + + + account + the account associated with the VPC. Must be used with the domainId parameter. + false + string + + + asnumber + the AS Number of the VPC tiers + false + 4.20.0 + long + + + bgppeerids + Ids of the Bgp Peer for the VPC + false + list + 4.20.0 + list + + + cidr + the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR + false + string + + + cidrsize + the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode. + false + 4.20.0 + integer + + + displaytext + The display text of the VPC, defaults to its 'name'. + false + string + + + dns1 + the first IPv4 DNS for the VPC + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the VPC + false + 4.18.0 + string + + + domainid + the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain. + false + uuid + + + fordisplay + an optional field, whether to the display the vpc to the end user or not + false + 4.4 + boolean + + + ip6dns1 + the first IPv6 DNS for the VPC + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + false + 4.18.0 + string + + + networkdomain + VPC network domain. All networks inside the VPC will belong to this domain + false + string + + + projectid + create VPC for the project + false + uuid + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. +If an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented, + false + 4.19 + string + + + start + If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default. + false + 4.3 + boolean + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + asnumber + AS NUMBER + 4.20.0 + long + + + asnumberid + UUID of AS NUMBER + 4.20.0 + string + + + bgppeers + The BGP peers for the VPC + 4.20.0 + set + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip4routes + The routes for the VPC to ease adding route in upstream router + 4.20.0 + set + + + ip4routing + The IPv4 routing mode of VPC + 4.20.0 + string + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + removeResourceDetail + Removes detail for the Resource. + true + + + resourceid + Delete details for resource id + true + string + + + resourcetype + Delete detail by resource type + true + string + + + key + Delete details matching key/value pairs + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listOsTypes + Lists all supported OS types for this cloud. + false + + + description + list os by description + false + 3.0.1 + string + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.18.1 + boolean + + + id + list by Os type Id + false + uuid + + + keyword + List by keyword + false + string + + + oscategoryid + list by Os Category id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + fordisplay + is the guest OS visible for the users + boolean + + + isuserdefined + is the guest OS user defined + boolean + + + name + the name of the OS type + string + + + oscategoryid + the ID of the OS category + string + + + oscategoryname + the name of the OS category + string + + + false + + + removeGuestOs + Removes a Guest OS from listing. + true + 4.4.0 + + + id + ID of the guest OS + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + detachIso + Detaches any ISO file (if any) currently attached to a virtual machine. + true + + + virtualmachineid + The ID of the virtual machine + true + uuid + + + forced + If true, ejects the ISO before detaching on VMware. Default: false + false + 4.15.1 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deletePaloAltoFirewall + delete a Palo Alto firewall device + true + + + fwdeviceid + Palo Alto firewall device ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + executeWebhookDelivery + Executes a Webhook delivery + false + 4.20.0 + + + id + The ID of the Webhook delivery for redelivery + false + uuid + + + payload + Payload of the Webhook delivery + false + string + + + payloadurl + Payload URL of the Webhook delivery + false + string + + + secretkey + Secret key of the Webhook delivery + false + string + + + sslverification + If set to true then SSL verification will be done for the Webhook delivery otherwise not + false + boolean + + + webhookid + The ID of the Webhook + false + uuid + + + + + id + The ID of the Webhook delivery + string + + + enddate + The end time of the Webhook delivery + date + + + eventid + The ID of the event + string + + + eventtype + The type of the event + string + + + headers + The headers of the webhook delivery + string + + + managementserverid + The ID of the management server which executed delivery + string + + + managementservername + The name of the management server which executed delivery + string + + + payload + The payload of the webhook delivery + string + + + response + The response of the webhook delivery + string + + + startdate + The start time of the Webhook delivery + date + + + success + Whether Webhook delivery succeeded or not + boolean + + + webhookid + The ID of the Webhook + string + + + webhookname + The name of the Webhook + string + + + false + + + deletePod + Deletes a Pod. + false + + + id + the ID of the Pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricProviders + Lists Tungsten-Fabric providers + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + false + uuid + + + + + name + Tungsten-Fabric provider name + string + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + tungstengateway + Tungsten-Fabric provider gateway + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + string + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + string + + + tungstenproviderport + Tungsten-Fabric provider port + string + + + tungstenprovideruuid + Tungsten-Fabric provider uuid + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listDeploymentPlanners + Lists all DeploymentPlanners available. + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + Deployment Planner name + string + + + false + + + deleteCluster + Deletes a cluster. + false + + + id + the cluster ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + prepareHostForMaintenance + Prepares a host for maintenance. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + arch + CPU Arch of the host + 4.20 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + explicithosttags + comma-separated list of explicit host tags for the host + 4.20.0 + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + implicithosttags + comma-separated list of implicit host tags for the host + 4.20.0 + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeRegion + Removes specified region + false + + + id + ID of the region to delete + true + integer + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getVolumeiScsiName + Get Volume's iSCSI Name + false + + + volumeid + CloudStack Volume UUID + true + string + + + + + volumeiScsiName + Volume iSCSI Name + string + + + false + + + updateAutoScaleVmGroup + Updates an existing autoscale vm group. + true + + + id + the ID of the autoscale group + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the group to the end user or not + false + 4.4 + boolean + + + interval + the frequency in which the performance counters to be collected + false + integer + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + false + integer + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + false + integer + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + scaledownpolicyids + list of scaledown autoscale policies + false + list + list + + + scaleuppolicyids + list of scaleup autoscale policies + false + list + list + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + deleteSnapshot + Deletes a snapshot of a disk volume. + true + + + id + The ID of the snapshot + true + uuid + + + zoneid + The ID of the zone for the snapshot + false + 4.19.0 + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVirtualMachines + List the virtual machines owned by the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + clusterid + the cluster ID + false + 4.16.0 + uuid + + + details + comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hostid + the host ID + false + uuid + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. + false + 4.19.0 + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + storageid + the storage ID where vm's volumes belong to + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listDiskOfferings + Lists all available disk offerings. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + encrypt + listed offerings support disk encryption + false + 4.18 + boolean + + + id + ID of the disk offering + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the disk offering + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings. + false + 4.19 + string + + + storageid + The ID of the storage pool, tags of the storage pool are used to filter the offerings + false + 4.17 + uuid + + + storagetype + the storage type of the service offering. Values are local and shared. + false + 4.19 + string + + + virtualmachineid + The ID of a virtual machine. Pass this in if you want to see the suitable disk offering that can be used to create and add a disk to the virtual machine. Suitability is returned with suitableforvirtualmachine flag in the response + false + 4.20.0 + uuid + + + volumeid + The ID of the volume, tags of the volume are used to filter the offerings + false + 4.17 + uuid + + + zoneid + id of zone disk offering is associated with + false + 4.13 + uuid + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + state + state of the disk offering + string + + + storagetype + the storage type for this disk offering + string + + + suitableforvirtualmachine + Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false + 4.20.0 + boolean + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + deleteCiscoAsa1000vResource + Deletes a Cisco ASA 1000v appliance + false + + + resourceid + Cisco ASA 1000v resource ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + upgradeKubernetesCluster + Upgrades a running CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + kubernetesversionid + the ID of the Kubernetes version for upgrade + true + uuid + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + listProjects + Lists projects and provides detailed information for listed projects + false + 3.0.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + details + comma separated list of project details requested, value can be a list of [ all, resource, min] + false + list + list + + + displaytext + list projects by display text + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list projects by project ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list projects by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for projects + false + boolean + + + state + list projects by state + false + string + + + tags + List projects by tags (key/value pairs) + false + map + map + + + username + List projects by username + false + string + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + taggedresources + The tagged resource limit and count for the project + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + createCondition + Creates a condition for VM auto scaling + true + + + counterid + ID of the Counter. + true + uuid + + + relationaloperator + Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE. + true + string + + + threshold + Value for which the Counter will be evaluated with the Operator selected. + true + long + + + account + the account of the condition. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID of the account. + false + uuid + + + projectid + an optional project for condition + false + uuid + + + + + id + the id of the Condition + string + + + account + the owner of the Condition. + string + + + counter + Details of the Counter. + counterresponse + + + counterid + the Id of the Counter. + string + + + countername + the Name of the Counter. + string + + + domain + the domain name of the owner. + string + + + domainid + the domain id of the Condition owner + string + + + domainpath + path of the domain to which the Condition owner belongs + 4.19.2.0 + string + + + project + the project name of the Condition + string + + + projectid + the project id of the Condition. + string + + + relationaloperator + Relational Operator to be used with threshold. + string + + + threshold + Threshold Value for the counter. + long + + + zoneid + zone id of counter + string + + + false + + + createAccount + Creates an account + false + + + email + email + true + string + + + firstname + firstname + true + string + + + lastname + lastname + true + string + + + password + Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Unique username. + true + string + + + account + Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accountid + Account UUID, required for adding account from external provisioning system + false + string + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + Creates the user under the specified domain. + false + uuid + + + networkdomain + Network domain for the account's networks + false + string + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + taggedresources + The tagged resource limit and count for the account + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + revertToVMSnapshot + Revert VM from a vmsnapshot. + true + 4.2.0 + + + vmsnapshotid + The ID of the vm snapshot + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeGuestOsMapping + Removes a Guest OS Mapping. + true + 4.4.0 + + + id + ID of the guest OS mapping + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricServiceGroup + create Tungsten-Fabric service group + true + + + endport + Tungsten-Fabric service group end port + true + integer + + + name + Tungsten-Fabric service group name + true + string + + + protocol + Tungsten-Fabric service group protocol + true + string + + + startport + Tungsten-Fabric service group start port + true + integer + + + zoneid + the ID of zone + true + uuid + + + + + endport + Tungsten-Fabric service group end port + int + + + name + Tungsten-Fabric service group name + string + + + protocol + Tungsten-Fabric service group protocol + string + + + startport + Tungsten-Fabric service group start port + int + + + uuid + Tungsten-Fabric service group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + recoverSharedFileSystem + Recover a Shared FileSystem by id + false + 4.20.0 + + + id + the ID of the shared filesystem to recover + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + registerIso + Registers an existing ISO into the CloudStack Cloud. + false + + + name + the name of the ISO + true + string + + + url + the URL to where the ISO is currently being hosted + true + string + + + zoneid + the ID of the zone you wish to register the ISO to. + true + uuid + + + account + an optional account name. Must be used with domainId. + false + string + + + arch + the CPU arch of the ISO. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + bootable + true if this ISO is bootable. If not passed explicitly its assumed to be true + false + boolean + + + checksum + the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + directdownload + true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + displaytext + the display text of the ISO, defaults to the 'name' + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + imagestoreuuid + Image store UUID + false + string + + + isdynamicallyscalable + true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory + false + boolean + + + isextractable + true if the ISO or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if you want this ISO to be featured + false + boolean + + + ispublic + true if you want to register the ISO to be publicly available to all users, false otherwise. + false + boolean + + + ostypeid + the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed + false + uuid + + + passwordenabled + true if password reset feature is supported; default is false + false + boolean + + + projectid + Register ISO for the project + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listCiscoAsa1000vResources + Lists Cisco ASA 1000v appliances + false + + + hostname + Hostname or ip address of the Cisco ASA 1000v appliance. + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + resourceid + Cisco ASA 1000v resource ID + false + uuid + + + + false + + + deletePortableIpRange + deletes a range of portable public IP's associated with a region + true + + + id + Id of the portable ip range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + upgradeRouterTemplate + Upgrades router to use newer template + false + + + account + upgrades all routers owned by the specified account + false + string + + + clusterid + upgrades all routers within the specified cluster + false + uuid + + + domainid + upgrades all routers owned by the specified domain + false + uuid + + + id + upgrades router with the specified Id + false + uuid + + + podid + upgrades all routers within the specified pod + false + uuid + + + zoneid + upgrades all routers within the specified zone + false + uuid + + + + + jobid + the UUID of the latest async job acting on this object + string + + + jobstatus + the current status of the latest async job acting on this object + integer + + + false + + + listIpv4SubnetsForGuestNetwork + Lists IPv4 subnets for guest networks. + false + 4.20.0 + + + id + UUID of the IPv4 subnet for guest network. + false + uuid + + + keyword + List by keyword + false + string + + + networkid + UUID of network to which the IPv4 subnet is associated to. + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + parentid + UUID of zone Ipv4 subnet which the IPv4 subnet belongs to. + false + uuid + + + subnet + The CIDR of the Ipv4 subnet. + false + string + + + vpcid + UUID of VPC to which the IPv4 subnet is associated to. + false + uuid + + + zoneid + UUID of zone to which the IPv4 subnet belongs to. + false + uuid + + + + + id + id of the IPv4 subnet for guest network + string + + + allocated + date when this IPv4 subnet was allocated. + date + + + created + date when this IPv4 subnet was created. + date + + + networkid + id of network which the IPv4 subnet is associated with. + string + + + networkname + name of network which the IPv4 subnet is associated with. + string + + + parentid + id of the data center IPv4 subnet + string + + + parentsubnet + subnet of the data center IPv4 subnet + string + + + removed + date when this IPv4 subnet was removed. + date + + + state + state of subnet of the IPv4 network + string + + + subnet + subnet of the IPv4 network + string + + + vpcid + Id of the VPC which the IPv4 subnet is associated with. + string + + + vpcname + Name of the VPC which the IPv4 subnet is associated with. + string + + + zoneid + id of zone to which the IPv4 subnet belongs to. + string + + + zonename + id of zone to which the IPv4 subnet belongs to. + string + + + false + + + extractVolume + Extracts volume + true + + + id + the ID of the volume + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + zoneid + the ID of the zone where the volume is located + true + uuid + + + url + the url to which the volume would be extracted + false + string + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + cancelHostMaintenance + Cancels host maintenance. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + arch + CPU Arch of the host + 4.20 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + explicithosttags + comma-separated list of explicit host tags for the host + 4.20.0 + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + implicithosttags + comma-separated list of implicit host tags for the host + 4.20.0 + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateZone + Updates a Zone. + false + + + id + the ID of the Zone + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + details + the details for the Zone + false + map + map + + + dhcpprovider + the dhcp Provider for the Zone + false + string + + + dns1 + the first DNS for the Zone + false + string + + + dns2 + the second DNS for the Zone + false + string + + + dnssearchorder + the dns search order list + false + list + list + + + domain + Network domain name for the networks in the zone; empty string will update domain with NULL value + false + string + + + guestcidraddress + the guest CIDR address for the Zone + false + string + + + internaldns1 + the first internal DNS for the Zone + false + string + + + internaldns2 + the second internal DNS for the Zone + false + string + + + ip6dns1 + the first DNS for IPv6 network in the Zone + false + string + + + ip6dns2 + the second DNS for IPv6 network in the Zone + false + string + + + ispublic + updates a private zone to public if set, but not vice-versa + false + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + false + boolean + + + name + the name of the Zone + false + string + + + sortkey + sort key of the zone, integer + false + integer + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + asnrange + AS Number Range + string + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + ismultiarch + true, if zone contains clusters and hosts from different CPU architectures + 4.20 + boolean + + + isnsxenabled + true, if zone is NSX enabled + 4.20.0 + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + tag + The tag for the capacity type + 4.20.0 + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listVlanIpRanges + Lists all VLAN IP ranges. + false + + + account + the account with which the VLAN IP range is associated. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain. + false + uuid + + + forvirtualnetwork + true if VLAN is of Virtual type, false if Direct + false + boolean + + + id + the ID of the VLAN IP range + false + uuid + + + keyword + List by keyword + false + string + + + networkid + network id of the VLAN IP range + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + physical network id of the VLAN IP range + false + uuid + + + podid + the Pod ID of the VLAN IP range + false + uuid + + + projectid + project who will own the VLAN + false + uuid + + + vlan + the ID or VID of the VLAN. Default is an "untagged" VLAN. + false + string + + + zoneid + the Zone ID of the VLAN IP range + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + fornsx + indicates whether IP range is dedicated to NSX resources or not + boolean + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + releaseIpv4SubnetForZone + Releases an existing dedicated IPv4 subnet for a zone. + true + 4.20.0 + + + id + Id of the guest network IPv4 subnet + true + uuid + + + + + id + id of the guest IPv4 subnet + string + + + account + the account of the IPv4 subnet + string + + + created + date when this IPv4 subnet was created. + date + + + domain + the domain name of the IPv4 subnet + string + + + domainid + the domain ID of the IPv4 subnet + string + + + project + the project name of the IPv4 subnet + string + + + projectid + the project id of the IPv4 subnet + string + + + subnet + guest IPv4 subnet + string + + + zoneid + id of zone to which the IPv4 subnet belongs to. + string + + + zonename + name of zone to which the IPv4 subnet belongs to. + string + + + false + + + listProjectAccounts + Lists project's accounts + false + 3.0.0 + + + projectid + ID of the project + true + uuid + + + account + list accounts of the project by account name + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectroleid + list accounts of the project by project role id + false + uuid + + + role + list accounts of the project by role + false + string + + + userid + list invitation by user ID + false + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + taggedresources + The tagged resource limit and count for the project + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateAutoScalePolicy + Updates an existing autoscale policy. + true + + + id + the ID of the autoscale policy + true + uuid + + + conditionids + the list of IDs of the conditions that are being evaluated on every interval + false + list + list + + + duration + the duration in which the conditions have to be true before action is taken + false + integer + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + quiettime + the cool down period in which the policy should not be evaluated after the action has been taken + false + integer + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + domainpath + path of the domain to which the autoscale policy belongs + 4.19.2.0 + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + createIpv4SubnetForZone + Creates a IPv4 subnet for a zone. + true + 4.20.0 + + + subnet + The CIDR of the IPv4 subnet. + true + string + + + zoneid + UUID of the zone which the IPv4 subnet belongs to. + true + uuid + + + account + account who will own the IPv4 subnet + false + string + + + domainid + domain ID of the account owning the IPv4 subnet + false + uuid + + + projectid + project who will own the IPv4 subnet + false + uuid + + + + + id + id of the guest IPv4 subnet + string + + + account + the account of the IPv4 subnet + string + + + created + date when this IPv4 subnet was created. + date + + + domain + the domain name of the IPv4 subnet + string + + + domainid + the domain ID of the IPv4 subnet + string + + + project + the project name of the IPv4 subnet + string + + + projectid + the project id of the IPv4 subnet + string + + + subnet + guest IPv4 subnet + string + + + zoneid + id of zone to which the IPv4 subnet belongs to. + string + + + zonename + name of zone to which the IPv4 subnet belongs to. + string + + + false + + + createDiskOffering + Creates a disk offering. + false + + + name + name of the disk offering + true + string + + + bytesreadrate + bytes read rate of the disk offering + false + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + long + + + byteswriterate + bytes write rate of the disk offering + false + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + long + + + cachemode + the cache mode to use for this disk offering. none, writeback or writethrough + false + 4.14 + string + + + customized + whether disk offering size is custom or not + false + boolean + + + customizediops + whether disk offering iops is custom or not + false + boolean + + + details + details to specify disk offering parameters + false + map + 4.16 + map + + + disksize + size of the disk offering in GB (1GB = 1,073,741,824 bytes) + false + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + false + 4.17 + boolean + + + displayoffering + an optional field, whether to display the offering to the end user or not. + false + boolean + + + displaytext + An alternate display text of the disk offering, defaults to 'name'. + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + encrypt + Volumes using this offering should be encrypted + false + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + false + integer + + + iopsreadrate + io requests read rate of the disk offering + false + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + long + + + iopswriterate + io requests write rate of the disk offering + false + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + long + + + maxiops + max iops of the disk offering + false + long + + + miniops + min iops of the disk offering + false + long + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + false + string + + + storagepolicy + Name of the storage policy defined at vCenter, this is applicable only for VMware + false + 4.15 + uuid + + + storagetype + the storage type of the disk offering. Values are local and shared. + false + string + + + tags + tags for the disk offering + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + unique ID of the disk offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.4 + string + + + created + the date this disk offering was created + date + + + details + additional key/value details tied with this disk offering + 4.17 + map + + + diskBytesReadRate + bytes read rate of the disk offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the disk offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the disk offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the disk offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + disksize + the size of the disk offering in GB + long + + + disksizestrictness + To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed + 4.17 + boolean + + + displayoffering + whether to display the offering to the end user or not. + boolean + + + displaytext + an alternate display text of the disk offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + encrypt + Whether disks using this offering will be encrypted on primary storage + 4.18 + boolean + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + true if disk offering uses custom size, false otherwise + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + boolean + + + maxiops + the max iops of the disk offering + long + + + miniops + the min iops of the disk offering + long + + + name + the name of the disk offering + string + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + state + state of the disk offering + string + + + storagetype + the storage type for this disk offering + string + + + suitableforvirtualmachine + Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false + 4.20.0 + boolean + + + tags + the tags for the disk offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the disk offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + listNetworkProtocols + Lists details of network protocols + false + 4.19.0 + + + option + The option of network protocols. Supported values are: protocolnumber, icmptype. + true + string + + + + + description + the description of the protocol parameter + string + + + details + the details of the protocol parameter + map + + + index + the index (ID, Value, Code, Type, Option, etc) of the protocol parameter + integer + + + name + the name of the protocol parameter + string + + + false + + + listLBHealthCheckPolicies + Lists load balancer health check policies. + false + 4.2.0 + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the health check policy + false + 4.4 + uuid + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the load balancer rule + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + migrateVirtualMachineWithVolume + Attempts Migration of a VM with its volumes to a different host + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host for a running instance, if hostId is not specified. false by default + false + 4.19.0 + boolean + + + hostid + Destination Host ID to migrate VM to. + false + uuid + + + migrateto + Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=<uuid>&migrateto[volume-index].pool=<uuid>Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume=<uuid> indicates the UUID of the volume that you want to migrate, and pool=<uuid> indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc> + false + map + map + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateUser + Updates a user account + false + + + id + User uuid + true + uuid + + + currentpassword + Current password that was being used by the user. You must inform the current password when updating the password. + false + string + + + email + email + false + string + + + firstname + first name + false + string + + + lastname + last name + false + string + + + mandate2fa + Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA + false + 4.18.0.0 + boolean + + + password + Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port + false + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userapikey + The API key for the user. Must be specified with userSecretKey + false + string + + + username + Unique username + false + string + + + usersecretkey + The secret key for the user. Must be specified with userApiKey + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + removeCertFromLoadBalancer + Removes a certificate from a load balancer rule + true + + + lbruleid + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + attachVolume + Attaches a disk volume to a virtual machine. + true + + + id + the ID of the disk volume + true + uuid + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + deviceid + The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.<br>When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:<ul><li>0 maps to /dev/xvda;</li><li>1 maps to /dev/xvdb;</li><li>2 maps /dev/xvdc and so on.</li></ul>Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure. + false + long + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addHost + Adds a new host. + false + + + hypervisor + hypervisor type of the host + true + string + + + podid + the Pod ID for the host + true + uuid + + + url + the host URL + true + string + + + zoneid + the Zone ID for the host + true + uuid + + + allocationstate + Allocation state of this Host for allocation of new resources + false + string + + + clusterid + the cluster ID for the host + false + uuid + + + clustername + the cluster name for the host + false + string + + + hosttags + list of tags to be added to the host + false + list + list + + + password + the password for the host; required to be passed for hypervisors other than VMWare + false + string + + + username + the username for the host; required to be passed for hypervisors other than VMWare + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + arch + CPU Arch of the host + 4.20 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + explicithosttags + comma-separated list of explicit host tags for the host + 4.20.0 + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + implicithosttags + comma-separated list of implicit host tags for the host + 4.20.0 + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listLoadBalancers + Lists internal load balancers + false + 4.2.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the load balancer + false + string + + + networkid + the network ID of the load balancer + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + scheme + the scheme of the load balancer. Supported value is internal in the current release + false + string + + + sourceipaddress + the source IP address of the load balancer + false + string + + + sourceipaddressnetworkid + the network ID of the source IP address + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + domainpath + path of the domain to which the Load Balancer belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateProject + Updates a project + true + 3.0.0 + + + id + id of the project to be modified + true + uuid + + + account + new Admin account for the project + false + string + + + displaytext + display text of the project + false + string + + + name + name of the project + false + 4.19.0 + string + + + roletype + Account level role to be assigned to the user/account : Admin/Regular + false + string + + + swapowner + when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true + false + boolean + + + userid + ID of the user to be promoted/demoted + false + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + taggedresources + The tagged resource limit and count for the project + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + registerUserKeys + This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user + false + + + id + User id + true + uuid + + + + + apikey + the api key of the registered user + string + + + secretkey + the secret key of the registered user + string + + + false + + + deleteLBStickinessPolicy + Deletes a load balancer stickiness policy. + true + 3.0.0 + + + id + the ID of the LB stickiness policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVpnConnections + Lists site to site vpn connection gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + id of the vpn connection + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + id of vpc + false + uuid + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + removeTungstenFabricPolicy + remove Tungsten-Fabric policy + true + + + networkuuid + the uuid of Tungsten-Fabric network + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateCloudToUseObjectStore + Migrate current NFS secondary storages to use object store. + false + 4.3.0 + + + provider + the image store provider name + true + string + + + details + the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + name + the name for the image store + false + string + + + url + the URL for the image store + false + string + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + createASNRange + Creates a range of Autonomous Systems for BGP Dynamic Routing + false + 4.20.0 + + + endasn + the end AS Number + true + long + + + startasn + the start AS Number + true + long + + + zoneid + the zone ID + true + uuid + + + + + id + ID of the AS Number Range + string + + + created + Created date + date + + + endasn + End AS Number + long + + + startasn + Start AS Number + long + + + zoneid + Zone ID + string + + + false + + + addTungstenFabricNetworkGatewayToLogicalRouter + add Tungsten-Fabric network gateway to logical router + true + + + logicalrouteruuid + Tungsten-Fabric logical router uuid + true + string + + + networkuuid + Tungsten-Fabric network uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listTungstenFabricNic + list Tungsten-Fabric nic + false + + + keyword + List by keyword + false + string + + + nicuuid + the uuid of Tungsten-Fabric nic + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric nic name + string + + + uuid + Tungsten-Fabric nic uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + applyTungstenFabricPolicy + apply Tungsten-Fabric policy + true + + + majorsequence + the major sequence of Tungsten-Fabric policy + true + integer + + + minorsequence + the minor sequence of Tungsten-Fabric policy + true + integer + + + networkuuid + the uuid of network + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listVmwareDcs + Retrieves VMware DC(s) associated with a zone. + false + + + zoneid + Id of the CloudStack zone. + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + listZones + Lists zones + false + + + available + true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false. + false + boolean + + + domainid + the ID of the domain associated with the zone + false + uuid + + + id + the ID of the zone + false + uuid + + + ids + the IDs of the zones, mutually exclusive with id + false + list + 4.19.0 + list + + + keyword + List by keyword + false + string + + + name + the name of the zone + false + string + + + networktype + the network type of the zone that the virtual machine belongs to + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the zones + false + boolean + + + showicon + flag to display the resource image for the zones + false + boolean + + + tags + List zones by resource tags (key/value pairs) + false + map + 4.3 + map + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + asnrange + AS Number Range + string + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + ismultiarch + true, if zone contains clusters and hosts from different CPU architectures + 4.20 + boolean + + + isnsxenabled + true, if zone is NSX enabled + 4.20.0 + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + tag + The tag for the capacity type + 4.20.0 + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + removeQuarantinedIp + Removes a public IP address from quarantine. Only IPs in active quarantine can be removed. + false + 4.19 + + + removalreason + The reason for removing the public IP address from quarantine prematurely. + true + string + + + id + The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine. + false + uuid + + + ipaddress + The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine. + false + string + + + + + id + ID of the quarantine process. + string + + + created + When the quarantine was created. + date + + + enddate + End date for the quarantine. + date + + + ipaddress + The public IP address in quarantine. + string + + + previousownerid + Account ID of the previous public IP address owner. + string + + + previousownername + Account name of the previous public IP address owner. + string + + + removalreason + The reason for removing the IP from quarantine prematurely. + string + + + removed + When the quarantine was removed. + date + + + removeraccountid + ID of the account that removed the IP from quarantine. + string + + + false + + + deleteBackupSchedule + Deletes the backup schedule of a VM + false + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBackupProviderOfferings + Lists external backup offerings of the provider + false + 4.14.0 + + + zoneid + The zone ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + releasePublicIpRange + Releases a Public IP range back to the system pool + false + + + id + the id of the Public IP range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricPublicNetwork + create Tungsten-Fabric public network + false + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetscalerLoadBalancerNetworks + lists network that are using a netscaler load balancer device + false + + + lbdeviceid + netscaler load balancer device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + asnumber + AS NUMBER + 4.20.0 + long + + + asnumberid + UUID of AS NUMBER + 4.20.0 + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + bgppeers + The BGP peers for the network + 4.20.0 + set + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip4routes + The routes for the network to ease adding route in upstream router + 4.20.0 + set + + + ip4routing + The IPv4 routing type of network + 4.20.0 + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The Ipv6 routing type of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listNetworkIsolationMethods + Lists supported methods of network isolation + false + 4.2.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + Network isolation method name + string + + + false + + + listHostHAResources + Lists host HA resources + false + 4.11 + + + hostid + List by host ID + false + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + listTungstenFabricFirewallPolicy + list Tungsten-Fabric firewall policy + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + firewallrule + list Tungsten-Fabric firewall rule + list + + + name + Tungsten-Fabric firewall policy name + string + + + uuid + Tungsten-Fabric firewall policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + importBackupOffering + Imports a backup offering using a backup provider + true + 4.14.0 + + + allowuserdrivenbackups + Whether users are allowed to create adhoc backups and backup schedules + true + boolean + + + description + the description of the backup offering + true + string + + + externalid + The backup offering ID (from backup provider side) + true + string + + + name + the name of the backup offering + true + string + + + zoneid + The zone ID + true + uuid + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + deleteDomain + Deletes a specified domain + true + + + id + ID of domain to delete + true + uuid + + + cleanup + true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + migrateVolume + Migrate volume + true + 3.0.0 + + + storageid + destination storage pool ID to migrate the volume to + true + uuid + + + volumeid + the ID of the volume + true + uuid + + + livemigrate + if the volume should be live migrated when it is attached to a running vm + false + boolean + + + newdiskofferingid + The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to. + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTungstenFabricApplicationPolicySet + create Tungsten-Fabric application policy set + true + + + name + Tungsten-Fabric application policy set name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + firewallpolicy + list Tungsten-Fabric firewall policy + list + + + name + Tungsten-Fabric policy name + string + + + tag + list Tungsten-Fabric tag + list + + + uuid + Tungsten-Fabric application policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listEvents + A command to list events. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + archived + true to list archived events otherwise false + false + 4.19.0 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + duration + the duration of the event + false + integer + + + enddate + the end date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss") + false + date + + + entrytime + the time the event was entered + false + integer + + + id + the ID of the event + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + level + the event level (INFO, WARN, ERROR) + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + the ID of the resource associated with the event + false + 4.17.0 + string + + + resourcetype + the type of the resource associated with the event + false + 4.17.0 + string + + + startdate + the start date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss") + false + date + + + startid + the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event + false + uuid + + + type + the event type (see event types) + false + string + + + + + id + the ID of the event + string + + + account + the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group) + string + + + archived + whether the event has been archived or not + boolean + + + created + the date the event was created + date + + + description + a brief description of the event + string + + + domain + the name of the account's domain + string + + + domainid + the id of the account's domain + string + + + domainpath + path of the Domain the account's domain belongs to + 4.19.2.0 + string + + + level + the event level (INFO, WARN, ERROR) + string + + + parentid + whether the event is parented + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + resourceid + the id of the resource + 4.17.0 + string + + + resourcename + the name of the resource + 4.17.0 + string + + + resourcetype + the type of the resource + 4.17.0 + string + + + state + the state of the event + state + + + type + the type of the event (see event types) + string + + + username + the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine) + string + + + false + + + listHostHAProviders + Lists HA providers + false + 4.11 + + + hypervisor + Hypervisor type of the resource + true + string + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + deleteBgpPeer + Deletes an existing Bgp Peer. + true + 4.20.0 + + + id + Id of the Bgp Peer + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTags + Creates resource tag(s) + true + 4.0.0 + + + resourceids + list of resources to create the tags for + true + list + list + + + resourcetype + type of the resource + true + string + + + tags + Map of tags (key/value pairs) + true + map + map + + + customer + identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createInternalLoadBalancerElement + Create an Internal Load Balancer element. + true + 4.2.0 + + + nspid + the network service provider ID of the internal load balancer element + true + uuid + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + resetApiLimit + Reset api count + false + + + account + the ID of the account whose limit to be reset + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVlanIpRange + Deletes a VLAN IP range. + false + + + id + the id of the VLAN IP range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + generateAlert + Generates an alert + true + 4.3 + + + description + Alert description + true + string + + + name + Name of the alert + true + string + + + type + Type of the alert + true + short + + + podid + Pod id for which alert is generated + false + uuid + + + zoneid + Zone id for which alert is generated + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + ldapConfig + (Deprecated, use addLdapConfiguration) Configure the LDAP context for this site. + false + 3.0.0 + + + binddn + Specify the distinguished name of a user with the search permission on the directory. + false + string + + + bindpass + Enter the password. + false + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + false + string + + + listall + If true return current LDAP configuration + false + boolean + + + port + Specify the LDAP port if required, default is 389. + false + integer + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain. + false + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com. + false + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL. + false + boolean + + + truststore + Enter the path to trust certificates store. + false + string + + + truststorepass + Enter the password for trust store. + false + string + + + + + binddn + Specify the distinguished name of a user with the search permission on the directory + string + + + bindpass + DN password + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + string + + + port + Specify the LDAP port if required, default is 389 + string + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL + string + + + true + + + listVsphereStoragePolicies + List vSphere storage policies + false + + + zoneid + ID of the zone + false + uuid + + + + + id + the ID of the Storage Policy + string + + + description + the description of the Storage Policy + string + + + name + the name of the Storage Policy + string + + + policyid + the identifier of the Storage Policy in vSphere DataCenter + string + + + zoneid + the ID of the Zone + string + + + false + + + migrateVPC + moves a vpc to another physical network + true + 4.11.0 + + + vpcid + the ID of the vpc + true + uuid + + + vpcofferingid + vpc offering ID + true + uuid + + + resume + true if previous network migration cmd failed + false + boolean + + + tiernetworkofferings + network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2 + false + map + map + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + asnumber + AS NUMBER + 4.20.0 + long + + + asnumberid + UUID of AS NUMBER + 4.20.0 + string + + + bgppeers + The BGP peers for the VPC + 4.20.0 + set + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip4routes + The routes for the VPC to ease adding route in upstream router + 4.20.0 + set + + + ip4routing + The IPv4 routing mode of VPC + 4.20.0 + string + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deletePortForwardingRule + Deletes a port forwarding rule + true + + + id + the ID of the port forwarding rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteGlobalLoadBalancerRule + Deletes a global load balancer rule. + true + + + id + the ID of the global load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateAnnotationVisibility + update an annotation visibility. + false + 4.16 + + + id + the id of the annotation + true + string + + + adminsonly + the annotation is visible for admins only + true + boolean + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + updateConfiguration + Updates a configuration. + false + + + name + the name of the configuration + true + string + + + accountid + the ID of the Account to update the parameter value for corresponding account + false + uuid + + + clusterid + the ID of the Cluster to update the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to update the parameter value for corresponding domain + false + uuid + + + imagestoreuuid + the ID of the Image Store to update the parameter value for corresponding image store + false + uuid + + + storageid + the ID of the Storage pool to update the parameter value for corresponding storage pool + false + uuid + + + value + the value of the configuration + false + string + + + zoneid + the ID of the Zone to update the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + configureHAForHost + Configures HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + provider + HA provider + true + string + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + listVolumesUsageHistory + Lists volume stats + false + 4.18.0 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the volume. + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the volume + string + + + name + the name of the volume + string + + + stats + the list of VM stats + list + + + false + + + dedicatePublicIpRange + Dedicates a Public IP range to an account + false + + + id + the id of the VLAN IP range + true + uuid + + + domainid + domain ID of the account owning a VLAN + true + uuid + + + account + account who will own the VLAN + false + string + + + projectid + project who will own the VLAN + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + fornsx + indicates whether IP range is dedicated to NSX resources or not + boolean + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + createProjectRolePermission + Adds API permissions to a project role + false + 4.15.0 + + + permission + The rule permission, allow or deny. Default: deny. + true + string + + + projectid + ID of project where project role permission is to be created + true + uuid + + + projectroleid + ID of the project role + true + uuid + + + rule + The API name or wildcard rule such as list* + true + string + + + description + The description of the role permission + false + string + + + + + id + the ID of the project role permission + string + + + projectid + the ID of the project + string + + + projectroleid + the ID of the project role to which the role permission belongs + string + + + projectrolename + the name of the project role to which the role permission belongs + string + + + false + + + deleteBucket + Deletes an empty Bucket. + false + 4.19.0 + + + id + The ID of the Bucket + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createConsoleEndpoint + Create a console endpoint to connect to a VM console + false + 4.18.0 + + + virtualmachineid + ID of the VM + true + uuid + + + token + (optional) extra security token, valid when the extra validation is enabled + false + string + + + + + details + details in case of an error + string + + + success + true if the console endpoint is generated properly + boolean + + + url + the console url + string + + + websocket + the console websocket options + consoleendpointwebsocketresponse + + + false + + + updateProjectRolePermission + Updates a project role permission and/or order + false + 4.15.0 + + + projectid + ID of project where project role permission is to be updated + true + uuid + + + projectroleid + ID of the project role + true + uuid + + + permission + Rule permission, can be: allow or deny + false + string + + + projectrolepermissionid + Project Role permission rule id + false + uuid + + + ruleorder + The parent role permission uuid, use 0 to move this rule at the top of the list + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addUserToProject + Adds user to a project + true + 4.14 + + + projectid + ID of the project to add the user to + true + uuid + + + username + Name of the user to be added to the project + true + string + + + email + email ID of user to which invitation to the project is going to be sent + false + string + + + projectroleid + ID of the project role + false + uuid + + + roletype + Project role type to be assigned to the user - Admin/Regular + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteTungstenFabricFirewallPolicy + delete Tungsten-Fabric firewall policy + true + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableHAForCluster + Disables HA cluster-wide + true + 4.11 + + + clusterid + ID of the cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + recoverVirtualMachine + Recovers a virtual machine. + false + + + id + The ID of the virtual machine + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + resetNetworkPermissions + Resets network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateBgpPeer + Updates an existing Bgp Peer. + true + 4.20.0 + + + id + Id of the Bgp Peer + true + uuid + + + asnumber + The AS number of the Bgp Peer. + false + long + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details are removed for this resource; if false or not set, no action) + false + boolean + + + details + BGP peer details in key/value pairs. + false + map + map + + + ip6address + The IPv6 address of the Bgp Peer. + false + string + + + ipaddress + The IPv4 address of the Bgp Peer. + false + string + + + password + The password of the Bgp Peer. + false + string + + + + + id + id of the bgp peer + string + + + account + the account of the bgp peer + string + + + asnumber + AS number of bgp peer + long + + + created + date when this bgp peer was created. + date + + + details + additional key/value details of the bgp peer + map + + + domain + the domain name of the bgp peer + string + + + domainid + the domain ID of the bgp peer + string + + + ip6address + IPv6 address of bgp peer + string + + + ipaddress + IPv4 address of bgp peer + string + + + password + password of bgp peer + string + + + project + the project name of the bgp peer + string + + + projectid + the project id of the bgp peer + string + + + zoneid + id of zone to which the bgp peer belongs to. + string + + + zonename + name of zone to which the bgp peer belongs to. + string + + + false + + + updateTungstenFabricLBHealthMonitor + update Tungsten-Fabric loadbalancer health monitor + true + + + interval + loadbalancer health monitor interval + true + integer + + + lbruleid + the ID of lb rule + true + uuid + + + retry + loadbalancer health monitor retry + true + integer + + + timeout + loadbalancer health monitor timeout + true + integer + + + type + loadbalancer health monitor type + true + string + + + expectedcode + loadbalancer health monitor expected code + false + string + + + httpmethodtype + loadbalancer health monitor http method + false + string + + + urlpath + loadbalancer health monitor url path + false + string + + + + + id + the health monitor ID + long + + + expectedcode + the health monitor expected code + string + + + httpmethod + the health monitor http method + string + + + interval + the health monitor interval + int + + + lbruleid + the LB rule ID + string + + + retry + the health monitor retry + int + + + timeout + the health monitor timeout + int + + + type + the health monitor type + string + + + urlpath + the health monitor url path + string + + + uuid + the health monitor UUID + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + releaseDedicatedHost + Release the dedication for host + true + + + hostid + the ID of the host + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateProjectInvitation + Accepts or declines project invitation + true + 3.0.0 + + + projectid + id of the project to join + true + uuid + + + accept + if true, accept the invitation, decline if false. True by default + false + boolean + + + account + account that is joining the project + false + string + + + token + list invitations for specified account; this parameter has to be specified with domainId + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + revertSnapshot + This is supposed to revert a volume snapshot. This command is only supported with KVM so far + true + + + id + The ID of the snapshot + true + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateCondition + Updates a condition for VM auto scaling + true + 4.18.0 + + + id + the ID of the condition. + true + uuid + + + relationaloperator + Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE. + true + string + + + threshold + Value for which the Counter will be evaluated with the Operator selected. + true + long + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listRegions + Lists Regions + false + + + id + List Region by region ID. + false + integer + + + keyword + List by keyword + false + string + + + name + List Region by region name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + listCounters + List the counters for VM auto scaling + false + + + id + ID of the Counter. + false + uuid + + + keyword + List by keyword + false + string + + + name + Name of the counter. + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + Network provider of the counter. + false + 4.18.0 + string + + + source + Source of the counter. + false + string + + + + + id + the id of the Counter + string + + + name + Name of the counter. + string + + + provider + Provider of the counter. + string + + + source + Source of the counter. + string + + + value + Value in case of snmp or other specific counters. + string + + + zoneid + zone id of counter + string + + + false + + + migrateSystemVm + Attempts Migration of a system virtual machine to the host specified. + true + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + autoselect + Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default + false + 4.16.0 + boolean + + + hostid + destination Host ID to migrate VM to + false + uuid + + + storageid + Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume + false + 4.16.0 + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + configureInternalLoadBalancerElement + Configures an Internal Load Balancer element. + true + 4.2.0 + + + id + the ID of the internal lb provider + true + uuid + + + enabled + Enables/Disables the Internal Load Balancer element + true + boolean + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + removeTungstenFabricTag + remove Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + networkuuid + the uuid of networks + false + list + list + + + nicuuid + the uuid of nics + false + list + list + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + vmuuid + the uuid of vms + false + list + list + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listVirtualRouterElements + Lists all available virtual router elements. + false + + + enabled + list network offerings by enabled state + false + boolean + + + id + list virtual router elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list virtual router elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + deleteIpv4SubnetForGuestNetwork + Deletes an existing IPv4 subnet for guest network. + true + 4.20.0 + + + id + Id of the guest network IPv4 subnet + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + linkAccountToLdap + link a cloudstack account to a group or OU in ldap + false + 4.11.0 + + + account + name of the account, it will be created if it does not exist + true + string + + + domainid + The id of the domain that is to contain the linked account. + true + uuid + + + ldapdomain + name of the group or OU in LDAP + true + string + + + accounttype + Type of the account to auto import. Specify 0 for user and 2 for domain admin + false + integer + + + admin + domain admin username in LDAP + false + string + + + roleid + Creates the account under the specified role. + false + 4.19.1 + uuid + + + type + type of the ldap name. GROUP or OU, defaults to GROUP + false + string + + + + + accountid + Domain Admin accountId that is created + string + + + accounttype + Type of the account to auto import + int + + + domainid + id of the Domain which is linked to LDAP + string + + + ldapdomain + name of the group or OU in LDAP which is linked to the domain + string + + + name + name of the group or OU in LDAP which is linked to the domain + string + + + type + type of the name in LDAP which is linked to the domain + string + + + false + + + createRoutingFirewallRule + Creates a routing firewall rule in the given network in ROUTED mode + true + 4.20.0 + + + networkid + The network of the VM the firewall rule will be created for + true + uuid + + + protocol + the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + true + string + + + cidrlist + the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + destcidrlist + the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + startport + the starting port of firewall rule + false + integer + + + traffictype + the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + disableOutOfBandManagementForHost + Disables out-of-band management for a host + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + cancelHostAsDegraded + Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'. + true + 4.16.0.0 + + + id + host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + arch + CPU Arch of the host + 4.20 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + explicithosttags + comma-separated list of explicit host tags for the host + 4.20.0 + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + implicithosttags + comma-separated list of implicit host tags for the host + 4.20.0 + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + releaseASNumber + Releases an AS Number back to the pool + false + 4.20.0 + + + asnumber + the AS Number to be released + true + long + + + zoneid + the zone ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createSecurityGroup + Creates a security group + false + + + name + name of the security group + true + string + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + description + the description of the security group + false + string + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + Create security group for project + false + uuid + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listNetworkPermissions + List network visibility and all accounts that have permissions to view this network. + false + 4.17.0 + + + networkid + Lists network permission by network ID + true + uuid + + + + + account + the account the network is available for + string + + + accountid + the ID of account the network is available for + string + + + domain + the name of the domain to which the network belongs + string + + + domainid + the ID of the domain to which the network belongs + string + + + networkid + the network ID + string + + + project + the project the network is available for + string + + + projectid + the ID of project the network is available for + string + + + false + + + removeVirtualMachineFromBackupOffering + Removes a VM from any existing backup offering + true + 4.14.0 + + + virtualmachineid + ID of the virtual machine + true + uuid + + + forced + Whether to force remove VM from the backup offering that may also delete VM backups. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVpnGateways + Lists site 2 site vpn gateways + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + id of the vpn gateway + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + id of vpc + false + uuid + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + moveUser + Moves a user to another account in the same domain. + false + 4.11 + + + id + id of the user to be moved. + true + uuid + + + account + Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id. + false + string + + + accountid + Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name. + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + releaseHostReservation + Releases host reservation. + true + + + id + the host ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVpnConnection + Create site to site vpn connection + true + + + s2scustomergatewayid + id of the customer gateway + true + uuid + + + s2svpngatewayid + id of the vpn gateway + true + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + passive + connection is passive or not + false + boolean + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + listBrocadeVcsDeviceNetworks + lists network that are using a brocade vcs switch + false + + + vcsdeviceid + brocade vcs switch ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + asnumber + AS NUMBER + 4.20.0 + long + + + asnumberid + UUID of AS NUMBER + 4.20.0 + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + bgppeers + The BGP peers for the network + 4.20.0 + set + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip4routes + The routes for the network to ease adding route in upstream router + 4.20.0 + set + + + ip4routing + The IPv4 routing type of network + 4.20.0 + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The Ipv6 routing type of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listWebhookDeliveries + Lists Webhook deliveries + false + 4.20.0 + + + enddate + The end date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having end date equal to or before the specified date will be listed. + false + date + + + eventtype + The event type of the Webhook delivery + false + string + + + id + The ID of the Webhook delivery + false + uuid + + + keyword + List by keyword + false + string + + + managementserverid + The ID of the management server + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + startdate + The start date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having start date equal to or after the specified date will be listed. + false + date + + + webhookid + The ID of the Webhook + false + uuid + + + + + id + The ID of the Webhook + string + + + account + The account associated with the Webhook + string + + + created + The date when this Webhook was created + date + + + description + The description of the Webhook + string + + + domain + The name of the domain in which the Webhook exists + string + + + domainid + The ID of the domain in which the Webhook exists + string + + + domainpath + path of the domain to which the Webhook belongs + string + + + name + The name of the Webhook + string + + + payloadurl + The payload URL end point for the Webhook + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + scope + The scope of the Webhook + string + + + secretkey + The secret key for the Webhook + string + + + sslverification + Whether SSL verification is enabled for the Webhook + boolean + + + state + The state of the Webhook + string + + + false + + + dedicateHost + Dedicates a host. + true + + + domainid + the ID of the containing domain + true + uuid + + + hostid + the ID of the host to update + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the host + string + + + affinitygroupid + the Dedication Affinity Group ID of the host + string + + + domainid + the domain ID of the host + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + false + + + addGloboDnsHost + Adds the GloboDNS external host + true + 4.5.0 + + + password + Password for GloboDNS + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + GloboDNS url + true + string + + + username + Username for GloboDNS + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + logout + Logs out the user + false + + + + description + Response description + string + + + false + + + importRole + Imports a role based on provided map of rule permissions + false + 4.15.0 + + + name + Creates a role with this unique name + true + string + + + rules + Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing + true + map + map + + + description + The description of the role + false + string + + + forced + Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false. + false + boolean + + + ispublic + Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public). + false + boolean + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + state + the state of the role + string + + + type + the type of the role + string + + + false + + + quotaEmailTemplateUpdate + Updates existing email templates for quota alerts + false + 4.7.0 + + + templatebody + The quota email template body, max: 500k characters + true + string + + + templatesubject + The quota email template subject, max: 77 characters + true + string + + + templatetype + Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY + true + string + + + locale + The locale of the email text + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + restartSharedFileSystem + Restart a Shared FileSystem + true + 4.20.0 + + + id + the ID of the shared filesystem + true + uuid + + + cleanup + is cleanup required + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteTungstenFabricTagType + delete Tungsten-Fabric tag type + true + + + tagtypeuuid + the ID of Tungsten-Fabric tag type + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkServiceProviders + Lists network serviceproviders for a given physical network. + false + 3.0.0 + + + keyword + List by keyword + false + string + + + name + list providers by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + state + list providers by state + false + string + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + deleteNetscalerControlCenter + Delete Netscaler Control Center + false + + + id + Netscaler Control Center ID + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteObjectStoragePool + Deletes an Object Storage Pool + false + 4.19.0 + + + id + The Object Storage ID. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVolume + Deletes a detached disk volume. + false + + + id + The ID of the disk volume + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateSecondaryStorageSelector + Updates an existing secondary storage selector. + false + 4.19.0 + + + id + The unique identifier of the secondary storage selector. + true + uuid + + + heuristicrule + The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID. + true + string + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + enableUser + Enables a user account + false + + + id + Enables user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + quotaTariffCreate + Creates a quota tariff for a resource. + false + 4.18.0.0 + + + name + Quota tariff's name + true + string + + + usagetype + Integer value for the usage type of the resource. + true + integer + + + value + The quota tariff value of the resource as per the default unit. + true + double + + + activationrule + Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. + false + string + + + description + Quota tariff's description. + false + string + + + enddate + The end date of the quota tariff. If not informed, the tariff will be valid indefinitely. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone. + false + date + + + position + Position in the execution sequence for tariffs of the same type + false + 4.20.0.0 + integer + + + startdate + The effective start date on/after which the quota tariff is effective. Inform null to use the current date. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "00:00:00"). If the recommended format is not used, the date will be considered in the server timezone. + false + date + + + + + id + the ID of the tariff + string + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + position + position in the execution sequence for tariffs of the same type + integer + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + false + + + suspendProject + Suspends a project + true + 3.0.0 + + + id + id of the project to be suspended + true + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + taggedresources + The tagged resource limit and count for the project + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getApiLimit + Get API limit count for the caller + false + + + + account + the account name of the api remaining count + string + + + accountid + the account uuid of the api remaining count + string + + + apiAllowed + currently allowed number of apis + int + + + apiIssued + number of api already issued + int + + + expireAfter + seconds left to reset counters + long + + + false + + + deleteStorageNetworkIpRange + Deletes a storage network IP Range. + true + 3.0.0 + + + id + the uuid of the storage network ip range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addVmwareDc + Adds a VMware datacenter to specified zone + false + + + name + Name of VMware datacenter to be added to specified zone. + true + string + + + vcenter + The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + true + string + + + zoneid + The Zone ID. + true + uuid + + + password + The password for specified username. + false + string + + + username + The Username required to connect to resource. + false + string + + + + + id + The VMware Datacenter ID + string + + + name + The VMware Datacenter name + string + + + vcenter + The VMware vCenter name/ip + string + + + zoneid + the Zone ID associated with this VMware Datacenter + long + + + false + + + updateIpv6FirewallRule + Updates Ipv6 firewall rule with specified ID + true + + + id + the ID of the ipv6 firewall rule + true + uuid + + + cidrlist + the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + endport + the ending port of Ipv6 firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the Ipv6 firewall rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + protocol + the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + false + string + + + startport + the starting port of Ipv6 firewall rule + false + integer + + + traffictype + the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateIsoPermissions + Updates ISO permissions + false + + + id + the template ID + true + uuid + + + accounts + a comma delimited list of accounts within caller's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + isextractable + true if the template/iso is extractable, false other wise. Can be set only by root admin + false + boolean + + + isfeatured + true for featured template/iso, false otherwise + false + boolean + + + ispublic + true for public template/iso, false for private templates/isos + false + boolean + + + op + permission operator (add, remove, reset) + false + string + + + projectids + a comma delimited list of projects. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVPCOffering + Deletes VPC offering + true + + + id + the ID of the VPC offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkACL + Deletes a network ACL + true + + + id + the ID of the network ACL + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + forgotPassword + Sends an email to the user with a token to reset the password using resetPassword command. + false + 4.20.0.0 + + + username + Username + true + string + + + domain + Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed. + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listASNRanges + List Autonomous Systems Number Ranges + false + 4.20.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the zone ID + false + uuid + + + + + id + ID of the AS Number Range + string + + + created + Created date + date + + + endasn + End AS Number + long + + + startasn + Start AS Number + long + + + zoneid + Zone ID + string + + + false + + + createTungstenFabricTag + create Tungsten-Fabric tag + true + + + tagtype + Tungsten-Fabric tag type + true + string + + + tagvalue + Tungsten-Fabric tag value + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + addOpenDaylightController + Adds an OpenDyalight controler + true + + + password + Credential to access the OpenDaylight API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + Api URL of the OpenDaylight Controller. + true + string + + + username + Username to access the OpenDaylight API + true + string + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + createZone + Creates a Zone. + false + + + dns1 + the first DNS for the Zone + true + string + + + internaldns1 + the first internal DNS for the Zone + true + string + + + name + the name of the Zone + true + string + + + networktype + network type of the zone, can be Basic or Advanced + true + string + + + allocationstate + Allocation state of this Zone for allocation of new resources + false + string + + + dns2 + the second DNS for the Zone + false + string + + + domain + Network domain name for the networks in the zone + false + string + + + domainid + the ID of the containing domain, null for public zones + false + uuid + + + guestcidraddress + the guest CIDR address for the Zone + false + string + + + internaldns2 + the second internal DNS for the Zone + false + string + + + ip6dns1 + the first DNS for IPv6 network in the Zone + false + string + + + ip6dns2 + the second DNS for IPv6 network in the Zone + false + string + + + isedge + true if the zone is an edge zone, false otherwise + false + 4.18.0 + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + false + boolean + + + securitygroupenabled + true if network is security group enabled, false otherwise + false + boolean + + + + + id + Zone id + string + + + allocationstate + the allocation state of the cluster + string + + + allowuserspecifyvrmtu + Allow end users to specify VR MTU + 4.18.0 + boolean + + + asnrange + AS Number Range + string + + + description + Zone description + string + + + dhcpprovider + the dhcp Provider for the Zone + string + + + displaytext + the display text of the zone + string + + + dns1 + the first DNS for the Zone + string + + + dns2 + the second DNS for the Zone + string + + + domain + Network domain name for the networks in the zone + string + + + domainid + the UUID of the containing domain, null for public zones + string + + + domainname + the name of the containing domain, null for public zones + string + + + guestcidraddress + the guest CIDR address for the Zone + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internaldns1 + the first internal DNS for the Zone + string + + + internaldns2 + the second internal DNS for the Zone + string + + + ip6dns1 + the first IPv6 DNS for the Zone + string + + + ip6dns2 + the second IPv6 DNS for the Zone + string + + + ismultiarch + true, if zone contains clusters and hosts from different CPU architectures + 4.20 + boolean + + + isnsxenabled + true, if zone is NSX enabled + 4.20.0 + boolean + + + localstorageenabled + true if local storage offering enabled, false otherwise + boolean + + + name + Zone name + string + + + networktype + the network type of the zone; can be Basic or Advanced + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + 4.3.0 + map + + + routerprivateinterfacemaxmtu + The maximum value the MTU can have on the VR's private interfaces + 4.18.0 + integer + + + routerpublicinterfacemaxmtu + The maximum value the MTU can have on the VR's public interfaces + 4.18.0 + integer + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + type + the type of the zone - core or edge + 4.18.0 + string + + + zonetoken + Zone Token + string + + + capacity(*) + the capacity of the Zone + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + tag + The tag for the capacity type + 4.20.0 + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + tags(*) + the list of resource tags associated with zone. + 4.3 + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + listDomainChildren + Lists all children domains belonging to a specified domain + false + + + id + list children domain by parent domain ID. + false + uuid + + + isrecursive + to return the entire tree, use the value "true". To return the first level children, use the value "false". + false + boolean + + + keyword + List by keyword + false + string + + + listall + 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 + false + boolean + + + name + list children domains by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for domains + false + boolean + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + taggedresources + The tagged resource limit and count for the domain + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + getVMPassword + Returns an encrypted password for the VM + false + + + id + The ID of the virtual machine + true + uuid + + + + + encryptedpassword + The base64 encoded encrypted password of the VM + string + + + false + + + assignToGlobalLoadBalancerRule + Assign load balancer rule or list of load balancer rules to a global load balancer rules. + true + + + id + the ID of the global load balancer rule + true + uuid + + + loadbalancerrulelist + the list load balancer rules that will be assigned to global load balancer rule + true + list + list + + + gslblbruleweightsmap + Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10' + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addImageStoreS3 + Adds S3 Image Store + false + 4.7.0 + + + accesskey + S3 access key + true + string + + + bucket + Name of the storage bucket + true + string + + + endpoint + S3 endpoint + true + string + + + secretkey + S3 secret key + true + string + + + connectiontimeout + Connection timeout (milliseconds) + false + integer + + + connectionttl + Connection TTL (milliseconds) + false + integer + + + maxerrorretry + Maximum number of times to retry on error + false + integer + + + s3signer + Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType + false + string + + + sockettimeout + Socket timeout (milliseconds) + false + integer + + + usehttps + Use HTTPS instead of HTTP + false + boolean + + + usetcpkeepalive + Whether TCP keep-alive is used + false + boolean + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + uploadTemplateDirectDownloadCertificate + Upload a certificate for HTTPS direct template download on KVM hosts + false + 4.11.0 + + + certificate + SSL certificate + true + string + + + hypervisor + Hypervisor type + true + string + + + name + Name for the uploaded certificate + true + string + + + zoneid + Zone to upload certificate + true + uuid + + + hostid + (optional) the host ID to upload certificate + false + uuid + + + + + id + the direct download certificate id + string + + + alias + the direct download certificate alias + string + + + hostsmap + the hosts where the certificate is uploaded to + list + + + hypervisor + the hypervisor of the hosts where the certificate is uploaded + string + + + issuer + the direct download certificate issuer + string + + + serialnum + the direct download certificate serial num + string + + + subject + the direct download certificate subject + string + + + validity + the direct download certificate issuer + string + + + version + the direct download certificate version + string + + + zoneid + the zone id where the certificate is uploaded + string + + + zonename + the zone name where the certificate is uploaded + string + + + false + + + importUnmanagedInstance + Import unmanaged virtual machine from a given cluster. + true + 4.14.0 + + + clusterid + the cluster ID + true + uuid + + + name + the name of the instance as it is known to the hypervisor + true + string + + + serviceofferingid + the service offering for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping using keys disk and diskOffering + false + map + map + + + details + used to specify the custom parameters. + false + map + map + + + displayname + the display name of the instance + false + string + + + domainid + import instance to the domain specified + false + uuid + + + forced + VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated + false + boolean + + + hostname + the host name of the instance + false + string + + + migrateallowed + vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool + false + boolean + + + nicipaddresslist + VM nic to ip address mapping using keys nic, ip4Address + false + map + map + + + nicnetworklist + VM nic to network id mapping using keys nic and network + false + map + map + + + projectid + import instance for the project + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createPhysicalNetwork + Creates a physical network + true + 3.0.0 + + + name + the name of the physical network + true + string + + + zoneid + the Zone ID for the physical network + true + uuid + + + broadcastdomainrange + the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic + false + string + + + domainid + domain ID of the account owning a physical network + false + uuid + + + isolationmethods + the isolation method for the physical network[VLAN/L3/GRE] + false + list + list + + + networkspeed + the speed for the physical network[1G/10G] + false + string + + + tags + Tag the physical network + false + list + list + + + vlan + the VLAN for the physical network + false + string + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + listAutoScaleVmGroups + Lists autoscale vm groups. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the autoscale vm group + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the loadbalancer + false + uuid + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the autoscale vmgroup + false + 4.18.0 + string + + + page + false + integer + + + pagesize + false + integer + + + policyid + the ID of the policy + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vmprofileid + the ID of the profile + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + updatePod + Updates a Pod. + false + + + id + the ID of the Pod + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + endip + the ending IP address for the Pod + false + string + + + gateway + the gateway for the Pod + false + string + + + name + the name of the Pod + false + string + + + netmask + the netmask of the Pod + false + string + + + startip + the starting IP address for the Pod + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + tag + The tag for the capacity type + 4.20.0 + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + attachIso + Attaches an ISO to a virtual machine. + true + + + id + the ID of the ISO file + true + uuid + + + virtualmachineid + the ID of the virtual machine + true + uuid + + + forced + If true, ejects existing ISO before attaching on VMware. Default: false + false + 4.15.1 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + ldapRemove + (Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site. + false + 3.0.1 + + + + binddn + Specify the distinguished name of a user with the search permission on the directory + string + + + bindpass + DN password + string + + + hostname + Hostname or ip address of the ldap server eg: my.ldap.com + string + + + port + Specify the LDAP port if required, default is 389 + string + + + queryfilter + You specify a query filter here, which narrows down the users, who can be part of this domain + string + + + searchbase + The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com + string + + + ssl + Check Use SSL if the external LDAP server is configured for LDAP over SSL + string + + + true + + + createUser + Creates a user for an account that already exists + false + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + true + string + + + email + email + true + string + + + firstname + firstname + true + string + + + lastname + lastname + true + string + + + password + Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. + true + string + + + username + Unique username. + true + string + + + domainid + Creates the user under the specified domain. Has to be accompanied with the account parameter + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + userid + User UUID, required for adding account from external provisioning system + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + resetPassword + Resets the password for the user using the token generated via forgotPassword command. + false + 4.20.0.0 + + + password + New password in clear text (Default hashed to SHA256SALT). + true + string + + + token + Token generated via forgotPassword command. + true + string + + + username + Username + true + string + + + domain + Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed. + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVpnGateway + Creates site to site vpn local gateway + true + + + vpcid + public ip address id of the vpn gateway + true + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + addResourceDetail + Adds detail for the Resource. + true + + + details + Map of (key/value pairs) + true + map + map + + + resourceid + resource id to create the details for + true + string + + + resourcetype + type of the resource + true + string + + + fordisplay + pass false if you want this detail to be disabled for the regular user. True by default + false + 4.4 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVpnUsers + Lists vpn users + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + The uuid of the Vpn user + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + username + the username of the vpn user. + false + string + + + + + id + the vpn userID + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'. + string + + + username + the username of the vpn user + string + + + false + + + registerUserData + Register a new userdata. + false + 4.18 + + + name + Name of the userdata + true + string + + + userdata + Base64 encoded userdata content. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + true + string + + + account + an optional account for the userdata. Must be used with domainId. + false + string + + + domainid + an optional domainId for the userdata. If the account parameter is used, domainId must also be used. + false + uuid + + + params + comma separated list of variables declared in userdata content + false + string + + + projectid + an optional project for the userdata + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteIpForwardingRule + Deletes an IP forwarding rule + true + + + id + the ID of the forwarding rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addRegion + Adds a Region + false + + + id + Id of the Region + true + integer + + + endpoint + Region service endpoint + true + string + + + name + Name of the region + true + string + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + generateUsageRecords + Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed + false + + + domainid + List events for the specified domain. + false + uuid + + + enddate + End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. + false + date + + + startdate + Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. + false + date + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateRolePermission + Updates a role permission order + false + 4.9.0 + + + roleid + ID of the role + true + uuid + + + permission + Rule permission, can be: allow or deny + false + 4.11 + string + + + ruleid + Role permission rule id + false + 4.11 + uuid + + + ruleorder + The parent role permission uuid, use 0 to move this rule at the top of the list + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAccounts + Lists accounts and provides detailed account information for listed accounts + false + + + accounttype + list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user). + false + integer + + + details + comma separated list of account details requested, value can be a list of [ all, resource, min] + false + list + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list account by account ID + false + uuid + + + iscleanuprequired + list accounts by cleanuprequired attribute (values are true or false) + false + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list account by account name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for accounts + false + boolean + + + state + list accounts by state. Valid states are enabled, disabled, and locked. + false + string + + + tag + Tag for resource type to return usage + false + 4.20.0 + string + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + taggedresources + The tagged resource limit and count for the account + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + destroyRouter + Destroys a router. + true + + + id + the ID of the router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listImageStores + Lists image stores. + false + 4.2.0 + + + id + the ID of the storage pool + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the image store + false + string + + + page + false + integer + + + pagesize + false + integer + + + protocol + the image store protocol + false + string + + + provider + the image store provider + false + string + + + readonly + read-only status of the image store + false + 4.15.0 + boolean + + + zoneid + the Zone ID for the image store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + deleteAccount + Deletes a account, and all users associated with this account + true + + + id + Account id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableOutOfBandManagementForCluster + Disables out-of-band management for a cluster + true + 4.9.0 + + + clusterid + the ID of the cluster + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + activateProject + Activates a project + true + 3.0.0 + + + id + id of the project to be modified + true + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + taggedresources + The tagged resource limit and count for the project + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteSslCert + Delete a certificate to CloudStack + false + + + id + Id of SSL certificate + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteAlerts + Delete one or more alerts. + false + + + enddate + end date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the alerts + false + list + list + + + startdate + start date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + delete by alert type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + registerOauthProvider + Register the OAuth2 provider in CloudStack + false + 4.19.0 + + + clientid + Client ID pre-registered in the specific OAuth provider + true + string + + + description + Description of the OAuth Provider + true + string + + + provider + Name of the provider from the list of OAuth providers supported in CloudStack + true + string + + + redirecturi + Redirect URI pre-registered in the specific OAuth provider + true + string + + + secretkey + Secret Key pre-registered in the specific OAuth provider + true + string + + + details + Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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 + false + map + map + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createAutoScaleVmProfile + Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature. + true + + + serviceofferingid + the service offering of the auto deployed virtual machine + true + uuid + + + templateid + the template of the auto deployed virtual machine + true + uuid + + + zoneid + availability zone for the auto deployed virtual machine + true + uuid + + + account + account that will own the autoscale VM profile + false + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + false + uuid + + + counterparam + counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161 + false + map + map + + + domainid + domain ID of the account owning a autoscale VM profile + false + uuid + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is expunged + false + integer + + + fordisplay + an optional field, whether to the display the profile to the end user or not + false + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. +Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 . +Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". + false + map + map + + + projectid + an optional project for the autoscale VM profile + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + 4.18.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18.1 + map + + + userdataid + the ID of the Userdata + false + 4.18.1 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + domainpath + path of the domain to which the vm profile belongs + 4.19.2.0 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base64 encoded VM user data + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.1 + string + + + userdataid + the id of userdata used for the VM + 4.18.1 + string + + + userdataname + the name of userdata used for the VM + 4.18.1 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.1 + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + listLBStickinessPolicies + Lists load balancer stickiness policies. + false + 3.0.0 + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer stickiness policy + false + uuid + + + keyword + List by keyword + false + string + + + lbruleid + the ID of the load balancer rule + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + addUcsManager + Adds a Ucs manager + false + + + password + the password of UCS + true + string + + + url + the name of UCS url + true + string + + + username + the username of UCS + true + string + + + zoneid + the Zone id for the ucs manager + true + uuid + + + name + the name of UCS manager + false + string + + + + + id + the ID of the ucs manager + string + + + name + the name of ucs manager + string + + + url + the url of ucs manager + string + + + zoneid + the zone ID of ucs manager + string + + + false + + + deleteVnfTemplate + Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected. + true + 4.19.0 + + + id + the ID of the template + true + uuid + + + forced + Force delete a template. + false + 4.9+ + boolean + + + issystem + Necessary if the template's type is system. + false + 4.20.0 + boolean + + + zoneid + the ID of zone of the template + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetscalerLoadBalancers + lists netscaler load balancer devices + false + + + keyword + List by keyword + false + string + + + lbdeviceid + netscaler load balancer device ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + createInstanceGroup + Creates a vm group + false + + + name + the name of the instance group + true + string + + + account + the account of the instance group. The account parameter must be used with the domainId parameter. + false + string + + + domainid + the domain ID of account owning the instance group + false + uuid + + + projectid + The project of the instance group + false + uuid + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + domainpath + path of the Domain the instance group belongs to + 4.19.2.0 + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + createLoadBalancer + Creates an internal load balancer + true + 4.2.0 + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + true + string + + + instanceport + the TCP port of the virtual machine where the network traffic will be load balanced to + true + integer + + + name + name of the load balancer + true + string + + + networkid + The guest network the load balancer will be created for + true + uuid + + + scheme + the load balancer scheme. Supported value in this release is Internal + true + string + + + sourceipaddressnetworkid + the network id of the source ip address + true + uuid + + + sourceport + the source port the network traffic will be load balanced from + true + integer + + + description + the description of the load balancer + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + sourceipaddress + the source IP address the network traffic will be load balanced from + false + string + + + + + id + the Load Balancer ID + string + + + account + the account of the Load Balancer + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + description + the description of the Load Balancer + string + + + domain + the domain of the Load Balancer + string + + + domainid + the domain ID of the Load Balancer + string + + + domainpath + path of the domain to which the Load Balancer belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the Load Balancer + string + + + networkid + Load Balancer network id + string + + + project + the project name of the Load Balancer + string + + + projectid + the project id of the Load Balancer + string + + + sourceipaddress + Load Balancer source ip + string + + + sourceipaddressnetworkid + Load Balancer source ip network id + string + + + loadbalancerinstance(*) + the list of instances associated with the Load Balancer + + + id + the instance ID + string + + + ipaddress + the ip address of the instance + string + + + name + the name of the instance + string + + + state + the state of the instance + string + + + list + + + loadbalancerrule(*) + the list of rules associated with the Load Balancer + + + instanceport + instance port of the load balancer rule + integer + + + sourceport + source port of the load balancer rule + integer + + + state + the state of the load balancer rule + string + + + list + + + tags(*) + the list of resource tags associated with the Load Balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + updateBackupSchedule + Updates a user-defined VM backup schedule + false + 4.14.0 + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY + true + string + + + schedule + custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28) + true + string + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + true + string + + + virtualmachineid + ID of the VM for which schedule is to be defined + true + uuid + + + + + id + ID of the VM backup + string + + + account + account name + string + + + accountid + account id + string + + + backupofferingid + backup offering id + string + + + backupofferingname + backup offering name + string + + + created + backup date + date + + + domain + domain name + string + + + domainid + domain id + string + + + externalid + external backup id + string + + + size + backup size in bytes + long + + + status + backup status + status + + + type + backup type + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + virtualsize + backup protected (virtual) size in bytes + long + + + volumes + backed up volumes + string + + + zone + zone name + string + + + zoneid + zone id + string + + + false + + + addPaloAltoFirewall + Adds a Palo Alto firewall device + true + + + networkdevicetype + supports only PaloAltoFirewall + true + string + + + password + Credentials to reach Palo Alto firewall device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the Palo Alto appliance. + true + string + + + username + Credentials to reach Palo Alto firewall device + true + string + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + createPrivateGateway + Creates a private gateway + true + 4.17.0 + + + gateway + the gateway of the Private gateway + true + string + + + ipaddress + the IP address of the Private gateaway + true + string + + + netmask + the netmask of the Private gateway + true + string + + + vpcid + the VPC network belongs to + true + uuid + + + aclid + the ID of the network ACL + false + uuid + + + associatednetworkid + The isolated network this private gateway is associated to. + false + 4.17.0 + uuid + + + bypassvlanoverlapcheck + when true bypasses VLAN id/range overlap check during private gateway creation + false + boolean + + + networkofferingid + the uuid of the network offering to use for the private gateways network connection + false + uuid + + + physicalnetworkid + the Physical Network ID the network belongs to + false + uuid + + + sourcenatsupported + source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported + false + boolean + + + vlan + the network implementation uri for the private gateway + false + string + + + + + id + the id of the private gateway + string + + + account + the account associated with the private gateway + string + + + aclid + ACL Id set for private gateway + string + + + aclname + ACL name set for private gateway + string + + + domain + the domain associated with the private gateway + string + + + domainid + the ID of the domain associated with the private gateway + string + + + domainpath + path of the domain to which the private gateway belongs + 4.19.2.0 + string + + + gateway + the gateway + string + + + ipaddress + the private gateway's ip address + string + + + netmask + the private gateway's netmask + string + + + physicalnetworkid + the physical network id + string + + + project + the project name of the private gateway + string + + + projectid + the project id of the private gateway + string + + + sourcenatsupported + Source Nat enable status + boolean + + + state + State of the gateway, can be Creating, Ready, Deleting + string + + + vlan + the network implementation uri for the private gateway + string + + + vpcid + VPC id the private gateway belongs to + string + + + vpcname + VPC name the private gateway belongs to + 4.13.2 + string + + + zoneid + zone id of the private gateway + string + + + zonename + the name of the zone the private gateway belongs to + string + + + false + + + deleteFirewallRule + Deletes a firewall rule + true + + + id + the ID of the firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateOauthProvider + Updates the registered OAuth provider details + false + 4.19.0 + + + id + id of the OAuth provider to be updated + true + uuid + + + clientid + Client ID pre-registered in the specific OAuth provider + false + string + + + description + Description of the OAuth Provider + false + string + + + enabled + OAuth provider will be enabled or disabled based on this value + false + boolean + + + redirecturi + Redirect URI pre-registered in the specific OAuth provider + false + string + + + secretkey + Secret Key pre-registered in the specific OAuth provider + false + string + + + + + id + ID of the provider + string + + + clientid + Client ID registered in the OAuth provider + string + + + description + Description of the provider registered + string + + + enabled + Whether the OAuth provider is enabled or not + boolean + + + name + Name of the provider + string + + + provider + Name of the provider + string + + + redirecturi + Redirect URI registered in the OAuth provider + string + + + secretkey + Secret key registered in the OAuth provider + string + + + false + + + uploadSslCert + Upload a certificate to CloudStack + false + + + certificate + SSL certificate + true + string + + + name + Name for the uploaded certificate + true + string + + + privatekey + Private key + true + string + + + account + account that will own the SSL certificate + false + string + + + certchain + Certificate chain of trust + false + string + + + domainid + domain ID of the account owning the SSL certificate + false + uuid + + + enabledrevocationcheck + Enables revocation checking for certificates + false + 4.15 + boolean + + + password + Password for the private key + false + string + + + projectid + an optional project for the SSL certificate + false + uuid + + + + + id + SSL certificate ID + string + + + account + account for the certificate + string + + + certchain + certificate chain + string + + + certificate + certificate + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + fingerprint + certificate fingerprint + string + + + loadbalancerrulelist + List of loabalancers this certificate is bound to + list + + + name + name + string + + + project + the project name of the certificate + string + + + projectid + the project id of the certificate + string + + + false + + + createVpnCustomerGateway + Creates site to site vpn customer gateway + true + + + cidrlist + guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,). + true + string + + + esppolicy + ESP policy of the customer gateway + true + string + + + gateway + public ip address id of the customer gateway + true + string + + + ikepolicy + IKE policy of the customer gateway + true + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes. + true + string + + + account + the account associated with the gateway. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain. + false + uuid + + + dpd + If DPD is enabled for VPN connection + false + boolean + + + esplifetime + Lifetime of phase 2 VPN connection to the customer gateway, in seconds + false + long + + + forceencap + Force Encapsulation for NAT traversal + false + boolean + + + ikelifetime + Lifetime of phase 1 VPN connection to the customer gateway, in seconds + false + long + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike + false + 4.15.1 + string + + + name + name of this customer gateway + false + string + + + projectid + create site-to-site VPN customer gateway for the project + false + 4.6 + uuid + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + false + 4.15.1 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + addBaremetalHost + add a baremetal host + false + + + hypervisor + hypervisor type of the host + true + string + + + podid + the Pod ID for the host + true + uuid + + + url + the host URL + true + string + + + zoneid + the Zone ID for the host + true + uuid + + + allocationstate + Allocation state of this Host for allocation of new resources + false + string + + + clusterid + the cluster ID for the host + false + uuid + + + clustername + the cluster name for the host + false + string + + + hosttags + list of tags to be added to the host + false + list + list + + + ipaddress + ip address intentionally allocated to this host after provisioning + false + string + + + password + the password for the host; required to be passed for hypervisors other than VMWare + false + string + + + username + the username for the host; required to be passed for hypervisors other than VMWare + false + string + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + arch + CPU Arch of the host + 4.20 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + explicithosttags + comma-separated list of explicit host tags for the host + 4.20.0 + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + implicithosttags + comma-separated list of implicit host tags for the host + 4.20.0 + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeAnnotation + remove an annotation. + false + 4.11 + + + id + the id of the annotation + true + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + disableRole + Disables a role + false + 4.20.0 + + + id + ID of the role + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteRolePermission + Deletes a role permission + false + 4.9.0 + + + id + ID of the role permission + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateVMSchedule + Update VM Schedule. + false + 4.19.0 + + + id + ID of VM schedule + true + uuid + + + description + Name of the schedule + false + string + + + enabled + Enable VM schedule + false + boolean + + + enddate + end date after which the schedule becomes inactiveUse format "yyyy-MM-dd hh:mm:ss") + false + date + + + schedule + Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month' + false + string + + + startdate + start date from which the schedule becomes activeUse format "yyyy-MM-dd hh:mm:ss") + false + date + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. + false + string + + + + + id + the ID of VM schedule + string + + + action + Action + action + + + created + Date when the schedule was created + date + + + description + Description of VM schedule + string + + + enabled + VM schedule is enabled + boolean + + + enddate + Date after which the schedule becomes inactive + date + + + schedule + Cron formatted VM schedule + string + + + startdate + Date from which the schedule is active + date + + + timezone + Timezone of the schedule + string + + + virtualmachineid + ID of virtual machine + string + + + false + + + listConfigurationGroups + Lists all configuration groups (primarily used for UI). + false + 4.18.0 + + + group + lists configuration group by group name + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + description + the description of the configuration group + string + + + name + the name of the configuration group + string + + + precedence + the precedence of the configuration group + long + + + subgroup(*) + the subgroups of the configuration group + + + name + the name of the configuration subgroup + string + + + precedence + the precedence of the configuration subgroup + long + + + list + + + false + + + releasePodIpAddress + Releases a Pod IP back to the Pod + false + + + id + UUID of the Pod IP + true + long + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateRemoteAccessVpn + Updates remote access vpn + true + 4.4 + + + id + id of the remote access vpn + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + destroyVirtualMachine + Destroys a virtual machine. Once destroyed, only the administrator can recover it. + true + + + id + The ID of the virtual machine + true + uuid + + + expunge + If true is passed, the vm is expunged immediately. False by default. + false + 4.2.1 + boolean + + + volumeids + Comma separated list of UUIDs for volumes that will be deleted + false + list + 4.12.0 + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + assignVirtualMachineToBackupOffering + Assigns a VM to a backup offering + true + 4.14.0 + + + backupofferingid + ID of the backup offering + true + uuid + + + virtualmachineid + ID of the virtual machine + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + startVirtualMachine + Starts a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + bootintosetup + Boot into hardware setup menu or not + false + 4.15.0.0 + boolean + + + clusterid + destination Cluster ID to deploy the VM to - parameter available for root admin only + false + uuid + + + considerlasthost + True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process. + false + 4.18.0 + boolean + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + 3.0.1 + uuid + + + podid + destination Pod ID to deploy the VM to - parameter available for root admin only + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listResourceIcon + Lists the resource icon for the specified resource(s) + false + 4.16.0.0 + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + base64image + base64 representation of resource icon + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + resourceobjecttype + + + false + + + createPod + Creates a new Pod. + false + + + name + the name of the Pod + true + string + + + zoneid + the Zone ID in which the Pod will be created + true + uuid + + + allocationstate + Allocation state of this Pod for allocation of new resources + false + string + + + endip + the ending IP address for the Pod + false + string + + + gateway + the gateway for the Pod + false + string + + + netmask + the netmask for the Pod + false + string + + + startip + the starting IP address for the Pod + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + tag + The tag for the capacity type + 4.20.0 + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + removeRawUsageRecords + Safely removes raw records from cloud_usage table + false + 4.6.0 + + + interval + 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 + true + integer + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + provisionCertificate + Issues and propagates client certificate on a connected host/agent using configured CA plugin + true + 4.11.0 + + + hostid + The host/agent uuid to which the certificate has to be provisioned (issued and propagated) + true + uuid + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + reconnect + Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listVirtualMachinesMetrics + Lists VM metrics + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + clusterid + the cluster ID + false + uuid + + + details + comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hostid + the host ID + false + uuid + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. + false + 4.19.0 + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod ID + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + storageid + the storage ID where vm's volumes belong to + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + cputotal + the total cpu capacity in Ghz + string + + + diskiopstotal + the total disk iops + long + + + diskread + disk read in MiB + string + + + diskwrite + disk write in MiB + string + + + memorytotal + the total memory capacity in GiB + string + + + networkread + network read in MiB + string + + + networkwrite + network write in MiB + string + + + false + + + deleteStoragePool + Deletes a storage pool. + false + + + id + Storage pool id + true + uuid + + + forced + Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal) + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listHosts + Lists hosts. + false + + + clusterid + lists hosts existing in particular cluster + false + uuid + + + details + comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats] + false + list + list + + + hahost + if true, list only hosts dedicated to HA + false + boolean + + + hypervisor + hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator + false + string + + + id + the id of the host + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the host + false + string + + + outofbandmanagementenabled + list hosts for which out-of-band management is enabled + false + boolean + + + outofbandmanagementpowerstate + list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown] + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID for the host + false + uuid + + + resourcestate + 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] + false + string + + + state + the state of the host + false + string + + + type + the host type + false + string + + + virtualmachineid + lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM + false + uuid + + + zoneid + the Zone ID for the host + false + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + arch + CPU Arch of the host + 4.20 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + explicithosttags + comma-separated list of explicit host tags for the host + 4.20.0 + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + implicithosttags + comma-separated list of implicit host tags for the host + 4.20.0 + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteGuestNetworkIpv6Prefix + Deletes an existing guest network IPv6 prefix. + true + 4.17.0.0 + + + id + Id of the guest network IPv6 prefix + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateStoragePool + Updates a storage pool. + false + 3.0.0 + + + id + the Id of the storage pool + true + uuid + + + capacitybytes + bytes CloudStack can provision from this storage pool + false + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + false + long + + + details + the details for the storage pool + false + map + 4.19.0 + map + + + enabled + false to disable the pool for allocation of new volumes, true to enable it back. + false + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + false + boolean + + + name + Change the name of the storage pool + false + 4.15 + string + + + tags + comma-separated list of tags for the storage pool + false + list + list + + + url + the URL of the storage pool + false + 4.19.0 + string + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listBackupRepositories + Lists all backup repositories + false + 4.20.0 + + + id + ID of the backup repository + false + uuid + + + keyword + List by keyword + false + string + + + name + name of the backup repository + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + the backup repository provider + false + string + + + zoneid + ID of the zone where the backup repository is to be added + false + uuid + + + + + id + the ID of the backup repository + string + + + address + the address / url of the backup repository + string + + + capacitybytes + capacity of the backup repository + long + + + created + the date and time the backup repository was added + date + + + mountopts + mount options for the backup repository + string + + + name + the name of the backup repository + string + + + provider + name of the provider + string + + + type + backup type + string + + + zoneid + the Zone ID of the backup repository + string + + + zonename + the Zone name of the backup repository + string + + + false + + + listTungstenFabricTag + Lists Tungsten-Fabric tags + false + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + keyword + List by keyword + false + string + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + nicuuid + the uuid of Tungsten-Fabric nic + false + string + + + page + false + integer + + + pagesize + false + integer + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + taguuid + the uuid of Tungsten-Fabric tag + false + string + + + vmuuid + the uuid of Tungsten-Fabric vm + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + importLdapUsers + Import LDAP users + false + 4.3.0 + + + account + Creates the user under the specified account. If no account is specified, the username will be used as the account name. + false + string + + + accountdetails + details for account used to store specific parameters + false + map + map + + + accounttype + Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin + false + integer + + + domainid + 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 + false + uuid + + + group + Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported. + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + roleid + Creates the account under the specified role. + false + uuid + + + timezone + Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. + false + string + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + moveDomain + Moves a domain and its children to a new parent domain. + false + 4.19.0.0 + + + domainid + The ID of the domain to be moved. + true + uuid + + + parentdomainid + The ID of the new parent domain of the domain to be moved. + true + uuid + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + taggedresources + The tagged resource limit and count for the domain + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + listNetworks + Lists all available networks. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + acltype + list networks by ACL (access control list) type. Supported values are account and domain + false + string + + + associatednetworkid + List networks by associated networks. Only available if create a Shared network. + false + 4.17.0 + uuid + + + canusefordeploy + list networks available for VM deployment + false + boolean + + + displaynetwork + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvpc + the network belongs to VPC + false + boolean + + + id + list networks by ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issystem + true if network is system, false otherwise + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkfilter + possible values are "account", "domain", "accountdomain","shared", and "all". Default value is "all".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared). + false + 4.17.0 + string + + + networkofferingid + list networks by network offering ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + list networks by physical network id + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + restartrequired + list networks by restartRequired + false + boolean + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + showicon + flag to display the resource icon for networks + false + boolean + + + specifyipranges + true if need to list only networks which support specifying IP ranges + false + boolean + + + supportedservices + list networks supporting certain services + false + list + list + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + type of the traffic + false + string + + + type + the type of the network. Supported values are: isolated, l2, shared and all + false + string + + + vlan + the ID or VID of the network + false + 4.17.0 + string + + + vpcid + List networks by VPC + false + uuid + + + zoneid + the zone ID of the network + false + uuid + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + asnumber + AS NUMBER + 4.20.0 + long + + + asnumberid + UUID of AS NUMBER + 4.20.0 + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + bgppeers + The BGP peers for the network + 4.20.0 + set + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip4routes + The routes for the network to ease adding route in upstream router + 4.20.0 + set + + + ip4routing + The IPv4 routing type of network + 4.20.0 + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The Ipv6 routing type of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + releaseIpAddress + Releases an IP address from the account. + false + 4.17 + + + id + the ID of the public IP address to release + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updatePodManagementNetworkIpRange + Updates a management network IP range. Only allowed when no IPs are allocated. + true + 4.16.0.0 + + + currentendip + The current ending IP address. + true + string + + + currentstartip + The current starting IP address. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + newendip + The new ending IP address. + false + string + + + newstartip + The new starting IP address. + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateFirewallRule + Updates firewall rule + true + 4.4 + + + id + the ID of the firewall rule + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + quotaIsEnabled + Return true if the plugin is enabled + false + 4.7.0 + + + + isenabled + is quota service enabled + boolean + + + false + + + deleteOauthProvider + Deletes the registered OAuth provider + false + 4.19.0 + + + id + id of the OAuth provider to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaEmailTemplateList + Lists all quota email templates + false + 4.7.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + templatetype + List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY + false + string + + + + + last_updated + Last date/time when template was updated + date + + + locale + The quota email template locale + string + + + templatebody + The quota email template content + string + + + templatesubject + The quota email template subject + string + + + templatetype + Template type + string + + + false + + + createBgpPeer + Creates a Bgp Peer for a zone. + true + 4.20.0 + + + asnumber + The AS number of the Bgp Peer. + true + long + + + zoneid + UUID of the zone which the Bgp Peer belongs to. + true + uuid + + + account + account who will own the Bgp Peer + false + string + + + details + BGP peer details in key/value pairs. + false + map + map + + + domainid + domain ID of the account owning the Bgp Peer + false + uuid + + + ip6address + The IPv6 address of the Bgp Peer. + false + string + + + ipaddress + The IPv4 address of the Bgp Peer. + false + string + + + password + The password of the Bgp Peer. + false + string + + + projectid + project who will own the Bgp Peer + false + uuid + + + + + id + id of the bgp peer + string + + + account + the account of the bgp peer + string + + + asnumber + AS number of bgp peer + long + + + created + date when this bgp peer was created. + date + + + details + additional key/value details of the bgp peer + map + + + domain + the domain name of the bgp peer + string + + + domainid + the domain ID of the bgp peer + string + + + ip6address + IPv6 address of bgp peer + string + + + ipaddress + IPv4 address of bgp peer + string + + + password + password of bgp peer + string + + + project + the project name of the bgp peer + string + + + projectid + the project id of the bgp peer + string + + + zoneid + id of zone to which the bgp peer belongs to. + string + + + zonename + name of zone to which the bgp peer belongs to. + string + + + false + + + listHypervisors + List hypervisors + false + + + zoneid + the zone id for listing hypervisors. + false + uuid + + + + + name + Hypervisor name + string + + + false + + + dedicateBgpPeer + Dedicates an existing Bgp Peer to an account or a domain. + true + 4.20.0 + + + id + Id of the Bgp Peer + true + uuid + + + account + account who will own the Bgp Peer + false + string + + + domainid + domain ID of the account owning the Bgp Peer + false + uuid + + + projectid + project who will own the Bgp Peer + false + uuid + + + + + id + id of the bgp peer + string + + + account + the account of the bgp peer + string + + + asnumber + AS number of bgp peer + long + + + created + date when this bgp peer was created. + date + + + details + additional key/value details of the bgp peer + map + + + domain + the domain name of the bgp peer + string + + + domainid + the domain ID of the bgp peer + string + + + ip6address + IPv6 address of bgp peer + string + + + ipaddress + IPv4 address of bgp peer + string + + + password + password of bgp peer + string + + + project + the project name of the bgp peer + string + + + projectid + the project id of the bgp peer + string + + + zoneid + id of zone to which the bgp peer belongs to. + string + + + zonename + name of zone to which the bgp peer belongs to. + string + + + false + + + listHostsMetrics + Lists hosts metrics + false + 4.9.3 + + + clusterid + lists hosts existing in particular cluster + false + uuid + + + details + comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats] + false + list + list + + + hahost + if true, list only hosts dedicated to HA + false + boolean + + + hypervisor + hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator + false + string + + + id + the id of the host + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the host + false + string + + + outofbandmanagementenabled + list hosts for which out-of-band management is enabled + false + boolean + + + outofbandmanagementpowerstate + list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown] + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID for the host + false + uuid + + + resourcestate + 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] + false + string + + + state + the state of the host + false + string + + + type + the host type + false + string + + + virtualmachineid + lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM + false + uuid + + + zoneid + the Zone ID for the host + false + uuid + + + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedghz + the total cpu allocated in Ghz + string + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpuloadaverage + the average cpu load the last minute + double + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotalghz + the total cpu capacity in Ghz + string + + + cpuusedghz + the total cpu used in Ghz + string + + + instances + instances on the host + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedgb + the total memory allocated in GiB + string + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotalgb + the total memory capacity in GiB + string + + + memoryusedgb + the total memory used in GiB + string + + + networkread + network read in GiB + string + + + networkwrite + network write in GiB + string + + + powerstate + out-of-band management power state + powerstate + + + systeminstances + system vm instances on the host + string + + + false + + + releaseDedicatedPod + Release the dedication for the pod + true + + + podid + the ID of the Pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAffinityGroups + Lists affinity groups + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + list the affinity group by the ID provided + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + lists affinity groups by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + type + lists affinity groups by type + false + string + + + virtualmachineid + lists affinity groups by virtual machine ID + false + uuid + + + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + false + + + cancelShutdown + Cancels a triggered shutdown + false + 4.19.0 + + + managementserverid + the uuid of the management server + true + uuid + + + + + managementserverid + The id of the management server + long + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + registerSSHKeyPair + Register a public key in a keypair under a certain name + false + + + name + Name of the keypair + true + string + + + publickey + Public key material of the keypair + true + string + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the ssh key. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the ssh key + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the keypair + string + + + domain + the domain name of the keypair owner + string + + + domainid + the domain id of the keypair owner + string + + + fingerprint + Fingerprint of the public key + string + + + name + Name of the keypair + string + + + project + the project name of the keypair owner + string + + + projectid + the project id of the keypair owner + string + + + false + + + deleteEvents + Delete one or more events. + false + + + enddate + end date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + ids + the IDs of the events + false + list + list + + + startdate + start date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss") + false + date + + + type + delete by event type + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + reserveIpAddress + Reserve a public IP to an account. + false + 4.17 + + + id + the ID of the public IP address to reserve + true + uuid + + + account + the account to reserve with this IP address + false + string + + + domainid + the ID of the domain to reserve with this IP address + false + uuid + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + boolean + + + projectid + the ID of the project to reserve with this IP address + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forsystemvms + true if range is dedicated for System VMs + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteIso + Deletes an ISO file. + true + + + id + the ID of the ISO file + true + uuid + + + zoneid + the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getSolidFireVolumeSize + Get the SF volume size including Hypervisor Snapshot Reserve + false + + + volumeid + Volume UUID + true + string + + + + + solidFireVolumeSize + SolidFire Volume Size Including Hypervisor Snapshot Reserve + long + + + false + + + listVPCOfferings + Lists VPC offerings + false + + + displaytext + list VPC offerings by display text + false + string + + + domainid + list VPC offerings available for VPC creation in specific domain + false + 4.18 + uuid + + + id + list VPC offerings by id + false + uuid + + + isdefault + true if need to list only default VPC offerings. Default value is false + false + boolean + + + keyword + List by keyword + false + string + + + name + list VPC offerings by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + state + list VPC offerings by state + false + string + + + supportedservices + list VPC offerings supporting certain services + false + list + list + + + zoneid + id of zone VPC offering is associated with + false + 4.13 + uuid + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + fornsx + true if vpc offering can be used by NSX networks only + boolean + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + networkmode + Mode in which the network will operate. The valid values are NATTED and ROUTED + string + + + routingmode + the routing mode for the network offering, supported types are Static or Dynamic. + string + + + specifyasnumber + true if network offering supports choosing AS numbers + boolean + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + uploadVolume + Uploads a data disk. + true + + + format + the format for the volume. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume + true + string + + + url + the URL of where the volume is hosted. Possible URL include http:// and https:// + true + string + + + zoneid + the ID of the zone the volume is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + checksum + the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + diskofferingid + the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown. + false + uuid + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain. + false + uuid + + + imagestoreuuid + Image store uuid + false + string + + + projectid + Upload volume for the project + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + configureOutOfBandManagement + Configures a host's out-of-band management interface + false + 4.9.0 + + + address + the host management interface IP address + true + string + + + driver + the host management interface driver, for example: ipmitool + true + string + + + hostid + the ID of the host + true + uuid + + + password + the host management interface password + true + string + + + port + the host management interface port + true + string + + + username + the host management interface user + true + string + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listStorageTags + Lists storage tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the storage tag + string + + + name + the name of the storage tag + string + + + poolid + the pool ID of the storage tag + long + + + false + + + createIpv4SubnetForGuestNetwork + Creates a IPv4 subnet for guest networks. + true + 4.20.0 + + + parentid + The zone Ipv4 subnet which the IPv4 subnet belongs to. + true + uuid + + + cidrsize + the CIDR size of IPv4 network. This is mutually exclusive with subnet. + false + integer + + + subnet + The CIDR of this Ipv4 subnet. + false + string + + + + + id + id of the IPv4 subnet for guest network + string + + + allocated + date when this IPv4 subnet was allocated. + date + + + created + date when this IPv4 subnet was created. + date + + + networkid + id of network which the IPv4 subnet is associated with. + string + + + networkname + name of network which the IPv4 subnet is associated with. + string + + + parentid + id of the data center IPv4 subnet + string + + + parentsubnet + subnet of the data center IPv4 subnet + string + + + removed + date when this IPv4 subnet was removed. + date + + + state + state of subnet of the IPv4 network + string + + + subnet + subnet of the IPv4 network + string + + + vpcid + Id of the VPC which the IPv4 subnet is associated with. + string + + + vpcname + Name of the VPC which the IPv4 subnet is associated with. + string + + + zoneid + id of zone to which the IPv4 subnet belongs to. + string + + + zonename + id of zone to which the IPv4 subnet belongs to. + string + + + false + + + deleteVMSchedule + Delete VM Schedule. + false + 4.19.0 + + + virtualmachineid + ID of VM + true + uuid + + + id + ID of VM schedule + false + uuid + + + ids + IDs of VM schedule + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTemplatePermissions + List template visibility and all accounts that have permissions to view this template. + false + + + id + the template ID + true + uuid + + + + + id + the template ID + string + + + account + the list of accounts the template is available for + list + + + domainid + the ID of the domain to which the template belongs + string + + + ispublic + true if this template is a public template, false otherwise + boolean + + + projectids + the list of projects the template is available for + list + + + false + + + listAnnotations + Lists annotations. + false + 4.11 + + + annotationfilter + possible values are "self" and "all". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access + false + 4.16.0 + string + + + entityid + the id of the entity for which to show annotations + false + string + + + entitytype + the entity type + false + string + + + id + the id of the annotation + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + userid + optional: the id of the user of the annotation + false + 4.16.0 + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + addSwift + Adds Swift. + false + 3.0.0 + + + url + the URL for swift + true + string + + + account + the account for swift + false + string + + + key + key for the user for swift + false + string + + + username + the username for swift + false + string + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + updateVpnCustomerGateway + Update site to site vpn customer gateway + true + + + id + id of customer gateway + true + uuid + + + cidrlist + guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,). + true + string + + + esppolicy + ESP policy of the customer gateway + true + string + + + gateway + public ip address id of the customer gateway + true + string + + + ikepolicy + IKE policy of the customer gateway + true + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes. + true + string + + + account + the account associated with the gateway. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain. + false + uuid + + + dpd + If DPD is enabled for VPN connection + false + boolean + + + esplifetime + Lifetime of phase 2 VPN connection to the customer gateway, in seconds + false + long + + + forceencap + Force encapsulation for Nat Traversal + false + boolean + + + ikelifetime + Lifetime of phase 1 VPN connection to the customer gateway, in seconds + false + long + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike + false + 4.15.1 + string + + + name + name of this customer gateway + false + string + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + false + 4.15.1 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + IPsec policy of customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipaddress + guest ip of the customer gateway + string + + + ipsecpsk + IPsec preshared-key of customer gateway + string + + + name + name of the customer gateway + string + + + project + the project name + string + + + projectid + the project id + string + + + removed + the date and time the host was removed + date + + + splitconnections + For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. + boolean + + + false + + + listSnapshotPolicies + Lists snapshot policies. + false + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the snapshot policy + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + volumeid + the ID of the disk volume + false + uuid + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + zone + The list of zones in which snapshot backup is scheduled + 4.19.0 + set + + + false + + + applyTungstenFabricTag + apply Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + networkuuid + the uuid of networks + false + list + list + + + nicuuid + the uuid of nics + false + list + list + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + vmuuid + the uuid of vms + false + list + list + + + + + name + Tungsten-Fabric tag name + string + + + network + list Tungsten-Fabric network + list + + + nic + list Tungsten-Fabric nic + list + + + policy + list Tungsten-Fabric policy + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + vm + list Tungsten-Fabric vm + list + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateObjectStoragePool + Updates object storage pool + false + 4.19.0 + + + id + Object Store ID + true + uuid + + + name + the name for the object store + false + string + + + url + the url for the object store + false + string + + + + + id + the ID of the object store + string + + + name + the name of the object store + string + + + providername + the provider name of the object store + string + + + storagetotal + the total size of the object store + long + + + storageused + the object store currently used size + long + + + url + the url of the object store + string + + + false + + + stopRouter + Stops a router. + true + + + id + the ID of the router + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + lockAccount + This deprecated function used to locks an account. Look for the API DisableAccount instead + false + + + account + Locks the specified account. + true + string + + + domainid + Locks the specified account on this domain. + true + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + taggedresources + The tagged resource limit and count for the account + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + deleteProjectInvitation + Deletes project invitation + true + 3.0.0 + + + id + id of the invitation + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createTungstenFabricFirewallPolicy + create Tungsten-Fabric firewall policy + true + + + name + Tungsten-Fabric firewall policy name + true + string + + + sequence + the sequence of Tungsten-Fabric firewall policy + true + integer + + + zoneid + the ID of zone + true + uuid + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + false + string + + + + + firewallrule + list Tungsten-Fabric firewall rule + list + + + name + Tungsten-Fabric firewall policy name + string + + + uuid + Tungsten-Fabric firewall policy uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + updateRegion + Updates a region + false + + + id + Id of region to update + true + integer + + + endpoint + updates region with this end point + false + string + + + name + updates region with this name + false + string + + + + + id + the ID of the region + integer + + + endpoint + the end point of the region + string + + + gslbserviceenabled + true if GSLB service is enabled in the region, false otherwise + boolean + + + name + the name of the region + string + + + portableipserviceenabled + true if security groups support is enabled, false otherwise + boolean + + + false + + + deleteTrafficType + Deletes traffic type of a physical network + true + 3.0.0 + + + id + traffic type id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + destroySharedFileSystem + Destroy a Shared FileSystem by id + true + 4.20.0 + + + expunge + If true is passed, the shared filesystem is expunged immediately. False by default. + false + boolean + + + forced + If true is passed, the shared filesystem can be destroyed without stopping it first. + false + boolean + + + id + the ID of the shared filesystem to delete + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listLdapConfigurations + Lists all LDAP configurations + false + 4.2.0 + + + domainid + linked domain + false + uuid + + + hostname + Hostname + false + string + + + keyword + List by keyword + false + string + + + listall + If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain + false + 4.13.2 + boolean + + + page + false + integer + + + pagesize + false + integer + + + port + Port + false + integer + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port the ldap server is running on + int + + + false + + + listProjectRolePermissions + Lists a project's project role permissions + false + 4.15.0 + + + projectid + ID of the project + true + uuid + + + projectroleid + ID of the project role + false + uuid + + + + + id + the ID of the project role permission + string + + + projectid + the ID of the project + string + + + projectroleid + the ID of the project role to which the role permission belongs + string + + + projectrolename + the name of the project role to which the role permission belongs + string + + + false + + + createRemoteAccessVpn + Creates a l2tp/ipsec remote access vpn + true + + + publicipid + public ip address id of the vpn server + true + uuid + + + account + an optional account for the VPN. Must be used with domainId. + false + string + + + domainid + an optional domainId for the VPN. If the account parameter is used, domainId must also be used. + false + uuid + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + iprange + the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server + false + string + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default + false + boolean + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + changeServiceForVirtualMachine + (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect. + false + + + id + The ID of the virtual machine + true + uuid + + + serviceofferingid + the service offering ID to apply to the virtual machine + true + uuid + + + automigrate + Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering + false + 4.17 + boolean + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + maxiops + New maximum number of IOPS for the custom disk offering + false + 4.17 + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + 4.17 + long + + + shrinkok + Verify OK to Shrink + false + 4.17 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + true + + + listTemplates + List all public, private, and privileged templates. + false + + + templatefilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + arch + the CPU arch of the template. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + details + comma separated list of template details requested, value can be a list of [ all, min] + false + list + 4.15 + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + the template ID + false + uuid + + + ids + the IDs of the templates, mutually exclusive with id + false + list + 4.9 + list + + + imagestoreid + ID of the image or image cache store + false + 4.19 + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list VNF templates or not; true if need to list VNF templates, false otherwise. + false + 4.19.0 + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the template name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parenttemplateid + list datadisk templates by parent template id + false + 4.4 + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the templates + false + boolean + + + showremoved + show removed templates as well + false + boolean + + + showunique + If set to true, list only unique templates across zones + false + 4.13.2 + boolean + + + storageid + ID of the storage pool + false + 4.19 + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templatetype + the type of the template + false + 4.19.0 + string + + + zoneid + list templates by zoneId + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listGuestOsMapping + Lists all available OS mappings for given hypervisor + false + 4.4.0 + + + hypervisor + list Guest OS mapping by hypervisor + false + string + + + hypervisorversion + list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter + false + string + + + id + list mapping by its UUID + false + uuid + + + keyword + List by keyword + false + string + + + osdisplayname + list Guest OS mapping by OS display name + false + string + + + osnameforhypervisor + list Guest OS mapping by OS mapping name with hypervisor + false + string + + + ostypeid + list mapping by Guest OS Type UUID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + createTungstenFabricPolicy + create Tungsten-Fabric policy + true + + + name + Tungsten-Fabric policy name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + deleteASNRange + deletes a range of Autonomous Systems for BGP Dynamic Routing + false + 4.20.0 + + + id + ID of the AS range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createBucket + Creates a bucket in the specified object storage pool. + true + 4.19.0 + + + name + the name of the bucket + true + string + + + objectstorageid + Id of the Object Storage Pool where bucket is created + true + uuid + + + account + the account associated with the bucket. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain. + false + uuid + + + encryption + Enable bucket encryption + false + boolean + + + objectlocking + Enable object locking in bucket + false + boolean + + + policy + The Bucket access policy + false + string + + + projectid + the project associated with the bucket. Mutually exclusive with account parameter + false + uuid + + + quota + Bucket Quota in GB + false + integer + + + versioning + Enable bucket versioning + false + boolean + + + + + id + ID of the Bucket + string + + + accesskey + Bucket Access Key + string + + + account + the account associated with the Bucket + string + + + created + the date the Bucket was created + date + + + domain + the domain associated with the bucket + string + + + domainid + the ID of the domain associated with the bucket + string + + + domainpath + path of the domain to which the bucket belongs + 4.19.2.0 + string + + + encryption + Bucket Encryption + boolean + + + name + name of the Bucket + string + + + objectlocking + Bucket Object Locking + boolean + + + objectstorageid + id of the object storage hosting the Bucket; returned to admin user only + string + + + objectstore + Name of the object storage hosting the Bucket; returned to admin user only + string + + + policy + Bucket Access Policy + string + + + project + the project name of the bucket + string + + + projectid + the project id of the bucket + string + + + provider + Object storage provider + string + + + quota + Bucket Quota in GB + integer + + + size + Total size of objects in Bucket + long + + + state + State of the Bucket + string + + + url + Bucket URL + string + + + usersecretkey + Bucket Secret Key + string + + + versioning + Bucket Versioning + boolean + + + false + + + listPhysicalNetworks + Lists physical networks + false + 3.0.0 + + + id + list physical network by id + false + uuid + + + keyword + List by keyword + false + string + + + name + search by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the Zone ID for the physical network + false + uuid + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + listFirewallRules + Lists all firewall rules for an IP address. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists rule with the specified ID. + false + uuid + + + ipaddressid + the ID of IP address of the firewall services + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list firewall rules for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + deleteBrocadeVcsDevice + delete a Brocade VCS Switch + true + + + vcsdeviceid + Brocade Switch ID + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listRoutingFirewallRules + Lists all Routing firewall rules + false + 4.20.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + boolean + + + id + Lists Routing firewall rule with the specified ID + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list Routing firewall rules by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + traffictype + list Routing firewall rules by traffic type - ingress or egress + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + extractIso + Extracts an ISO + true + + + id + the ID of the ISO file + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + url + the URL to which the ISO would be extracted + false + string + + + zoneid + the ID of the zone where the ISO is originally located + false + uuid + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + createAffinityGroup + Creates an affinity/anti-affinity group + true + + + name + name of the affinity group + true + string + + + type + Type of the affinity group from the available affinity/anti-affinity group types + true + string + + + account + an account for the affinity group. Must be used with domainId. + false + string + + + description + optional description of the affinity group + false + string + + + domainid + domainId of the account owning the affinity group + false + uuid + + + projectid + create affinity group for project + false + uuid + + + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + false + + + oauthlogin + Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired. + false + 4.19.0 + + + email + Email id with which user tried to login using OAuth provider + true + string + + + provider + Name of the provider + true + string + + + domain + Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed. + false + string + + + domainId + The id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precedence. + false + long + + + secretcode + Code that is provided by OAuth provider (Eg. google, github) after successful login + false + string + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + listInternalLoadBalancerElements + Lists all available Internal Load Balancer elements. + false + 4.2.0 + + + enabled + list internal load balancer elements by enabled state + false + boolean + + + id + list internal load balancer elements by id + false + uuid + + + keyword + List by keyword + false + string + + + nspid + list internal load balancer elements by network service provider id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the internal load balancer element + string + + + enabled + Enabled/Disabled the element + boolean + + + nspid + the physical network service provider id of the element + string + + + false + + + getHypervisorGuestOsNames + Gets the guest OS names in the hypervisor + true + 4.19.0 + + + hypervisor + Hypervisor type. One of : VMware, XenServer + true + string + + + hypervisorversion + Hypervisor version to get the guest os names (atleast one hypervisor host with the version specified must be available) + true + string + + + keyword + Keyword for guest os name + false + string + + + + + guestoscount + the guest OS count of the hypervisor + integer + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for guest os names + string + + + guestoslist(*) + the guest OS list of the hypervisor + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + list + + + false + + + createTungstenFabricProvider + Create Tungsten-Fabric provider in cloudstack + false + + + name + Tungsten-Fabric provider name + true + string + + + tungstengateway + Tungsten-Fabric provider gateway + true + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + true + string + + + zoneid + the ID of zone + true + uuid + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + false + string + + + tungstenproviderport + Tungsten-Fabric provider port + false + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + false + string + + + + + name + Tungsten-Fabric provider name + string + + + securitygroupsenabled + true if security groups support is enabled, false otherwise + boolean + + + tungstengateway + Tungsten-Fabric provider gateway + string + + + tungstenproviderhostname + Tungsten-Fabric provider hostname + string + + + tungstenproviderintrospectport + Tungsten-Fabric provider introspect port + string + + + tungstenproviderport + Tungsten-Fabric provider port + string + + + tungstenprovideruuid + Tungsten-Fabric provider uuid + string + + + tungstenprovidervrouterport + Tungsten-Fabric provider vrouter port + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + rebootVirtualMachine + Reboots a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + bootintosetup + Boot into hardware setup menu or not + false + 4.15.0.0 + boolean + + + forced + Force reboot the VM (VM is Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + enableHAForCluster + Enables HA cluster-wide + true + 4.11 + + + clusterid + ID of the cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addVirtualMachinesToKubernetesCluster + Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters. + false + 4.19.0 + + + id + the ID of the Kubernetes cluster + true + uuid + + + virtualmachineids + the IDs of the VMs to add to the cluster + true + list + list + + + iscontrolnode + Is control node or not? Defaults to false. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricLogicalRouter + list Tungsten-Fabric logical router + false + + + keyword + List by keyword + false + string + + + logicalrouteruuid + the uuid of Tungsten-Fabric logical router + false + string + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listBackupOfferings + Lists backup offerings + false + 4.14.0 + + + id + The backup offering ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + The zone ID + false + uuid + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + addGuestOsMapping + Adds a guest OS name to hypervisor OS name mapping + true + 4.4.0 + + + hypervisor + Hypervisor type. One of : XenServer, KVM, VMWare + true + string + + + hypervisorversion + Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version + true + string + + + osnameforhypervisor + OS name specific to the hypervisor + true + string + + + forced + Forces add user defined guest os mapping, overrides any existing user defined mapping + false + 4.19.0 + boolean + + + osdisplayname + Display Name of Guest OS standard type. Either Display Name or UUID must be passed + false + string + + + osmappingcheckenabled + When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.) + false + 4.19.0 + boolean + + + ostypeid + UUID of Guest OS type. Either the UUID or Display Name must be passed + false + uuid + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + listVnfTemplates + List all public, private, and privileged VNF templates. + false + 4.19.0 + + + templatefilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + arch + the CPU arch of the template. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + details + comma separated list of template details requested, value can be a list of [ all, min] + false + list + 4.15 + list + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + the template ID + false + uuid + + + ids + the IDs of the templates, mutually exclusive with id + false + list + 4.9 + list + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list VNF templates or not; true if need to list VNF templates, false otherwise. + false + 4.19.0 + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the template name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parenttemplateid + list datadisk templates by parent template id + false + 4.4 + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the templates + false + boolean + + + showremoved + show removed templates as well + false + boolean + + + showunique + If set to true, list only unique templates across zones + false + 4.13.2 + boolean + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templatetype + the type of the template + false + 4.19.0 + string + + + zoneid + list templates by zoneId + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deployVnfAppliance + Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template. + true + 4.19.0 + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter + false + list + list + + + bootintosetup + Boot into hardware setup or not (ignored if startVm = false, only valid for vmware) + false + 4.15.0.0 + boolean + + + bootmode + Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + boottype + Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + copyimagetags + if true the image tags (if any) will be copied to the VM, default value is false + false + 4.13 + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter + false + map + 4.11 + map + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + details + used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details + false + map + 4.3 + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + diskofferingid + the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created. + false + uuid + + + displayname + an optional user generated name for the virtual machine + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + 4.2 + boolean + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain. + false + uuid + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable + false + 4.16 + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + an optional group for the virtual machine + false + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + uuid + + + hypervisor + the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call + false + string + + + iodriverpolicy + Controls specific policies on IO + false + string + + + iothreadsenabled + IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs. + false + boolean + + + ip6address + the ipv6 address for default vm's network + false + string + + + ipaddress + the ip address for default vm's network + false + string + + + iptonetworklist + ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid + false + map + map + + + keyboard + an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us + false + string + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs used to login to the virtual machine + false + list + 4.17 + list + + + macaddress + the mac address for default vm's network + false + string + + + name + host name for the virtual machine + false + string + + + networkids + list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter + false + list + list + + + nicmultiqueuenumber + The number of queues for multiqueue NICs. + false + 4.18 + integer + + + nicnetworklist + VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid + false + map + 4.15 + map + + + nicpackedvirtqueuesenabled + Enable packed virtqueues or not. + false + 4.18 + boolean + + + overridediskofferingid + the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id + false + 4.17 + uuid + + + password + The password of the virtual machine. If null, a random password will be generated for the VM. + false + 4.19.0.0 + string + + + projectid + Deploy vm for the project + false + uuid + + + properties + used to specify the vApp properties. + false + map + 4.15 + map + + + rootdisksize + Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.4 + long + + + securitygroupids + comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + size + the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId + false + long + + + startvm + true if start vm after creating; defaulted to true if not specified + false + boolean + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the Userdata + false + 4.18 + uuid + + + vnfcidrlist + the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0. + false + list + list + + + vnfconfiguremanagement + True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups. + false + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateNetworkOffering + Updates a network offering. + false + + + availability + the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required + false + string + + + displaytext + the display text of the network offering + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + id + the id of the network offering + false + uuid + + + keepaliveenabled + if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file. + false + boolean + + + maxconnections + maximum number of concurrent connections supported by the network offering + false + integer + + + name + the name of the network offering + false + string + + + sortkey + sort key of the network offering, integer + false + integer + + + state + update state for the network offering + false + string + + + tags + the tags for the network offering. + false + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fornsx + true if network offering can be used by NSX networks only + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkmode + Mode in which the network will operate. The valid values are NATTED and ROUTED + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + routingmode + the routing mode for the network offering, supported types are Static or Dynamic. + string + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyasnumber + true if network offering supports choosing AS numbers + boolean + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportsinternallb + true if network offering supports public access for guest networks + 4.20.0 + boolean + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + changeOutOfBandManagementPassword + Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + password + the new host management interface password of maximum length 16, if none is provided a random password would be used + false + string + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listResourceDetails + List resource detail(s) + false + 4.2 + + + resourcetype + list by resource type + true + string + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + if set to true, only details marked with display=true, are returned. False by default + false + 4.3 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + key + list by key + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourceid + list by resource id + false + string + + + value + list by key, value. Needs to be passed only along with key + false + 4.4 + string + + + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + false + + + createNetworkOffering + Creates a network offering. + false + 3.0.0 + + + guestiptype + guest type of the network offering: Shared or Isolated + true + string + + + name + the name of the network offering + true + string + + + traffictype + the traffic type for the network offering. Supported type in current release is GUEST only + true + string + + + availability + the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks + false + string + + + conservemode + true if the network offering is IP conserve mode enabled + false + boolean + + + details + Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup + false + map + 4.2.0 + map + + + displaytext + the display text of the network offering, defaults to the value of 'name'. + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + false + boolean + + + enable + set to true if the offering is to be enabled during creation. Default is false + false + 4.16 + boolean + + + fornsx + true if network offering is meant to be used for NSX, false otherwise. + false + 4.20.0 + boolean + + + fortungsten + true if network offering is meant to be used for Tungsten-Fabric, false otherwise. + false + boolean + + + forvpc + true if network offering is meant to be used for VPC, false otherwise. + false + boolean + + + internetprotocol + The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6 + false + 4.17.0 + string + + + ispersistent + true if network offering supports persistent networks; defaulted to false if not specified + false + boolean + + + keepaliveenabled + if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file. + false + boolean + + + maxconnections + maximum number of concurrent connections supported by the network offering + false + integer + + + networkmode + Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED + false + 4.20.0 + string + + + networkrate + data transfer rate in megabits per second allowed + false + integer + + + nsxsupportlb + true if network offering for NSX network offering supports Load balancer service. + false + 4.20.0 + boolean + + + nsxsupportsinternallb + true if network offering for NSX network offering supports Internal Load balancer service. + false + 4.20.0 + boolean + + + routingmode + the routing mode for the network offering. Supported types are: Static or Dynamic. + false + 4.20.0 + string + + + servicecapabilitylist + desired service capabilities as part of network offering + false + map + map + + + serviceofferingid + the service offering ID used by virtual router provider + false + uuid + + + serviceproviderlist + provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network + false + map + map + + + specifyasnumber + true if network offering supports choosing AS number + false + 4.20.0 + boolean + + + specifyipranges + true if network offering supports specifying ip ranges; defaulted to false if not specified + false + boolean + + + specifyvlan + true if network offering supports vlans + false + boolean + + + supportedservices + services supported by the network offering + false + list + list + + + tags + the tags for the network offering. + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fornsx + true if network offering can be used by NSX networks only + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkmode + Mode in which the network will operate. The valid values are NATTED and ROUTED + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + routingmode + the routing mode for the network offering, supported types are Static or Dynamic. + string + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyasnumber + true if network offering supports choosing AS numbers + boolean + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportsinternallb + true if network offering supports public access for guest networks + 4.20.0 + boolean + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + dedicateCluster + Dedicate an existing cluster + true + + + clusterid + the ID of the Cluster + true + uuid + + + domainid + the ID of the containing domain + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the cluster + string + + + affinitygroupid + the Dedication Affinity Group ID of the cluster + string + + + clusterid + the ID of the cluster + string + + + clustername + the name of the cluster + string + + + domainid + the domain ID of the cluster + string + + + false + + + createIpForwardingRule + Creates an IP forwarding rule + true + + + ipaddressid + the public IP address ID of the forwarding rule, already associated via associateIp + true + uuid + + + protocol + the protocol for the rule. Valid values are TCP or UDP. + true + string + + + startport + the start port for the rule + true + integer + + + cidrlist + the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use. + false + list + list + + + endport + the end port for the rule + false + integer + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default + false + boolean + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listElastistorInterface + Lists the network Interfaces of elastistor + false + + + controllerid + controller id + false + string + + + + + id + the id of the volume + string + + + compression + compression + string + + + deduplication + deduplication + string + + + graceallowed + graceallowed + string + + + name + the name of the volume + string + + + sync + synchronization + string + + + false + + + quotaStatement + Create a quota statement + false + 4.7.0 + + + account + Optional, Account Id for which statement needs to be generated + true + string + + + domainid + Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain. + true + uuid + + + enddate + End of the period of the Quota statement. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone. + true + date + + + startdate + Start of the period of the Quota statement. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "00:00:00"). If the recommended format is not used, the date will be considered in the server timezone. + true + date + + + accountid + List usage records for the specified account + false + uuid + + + type + List quota usage records for the specified usage type + false + integer + + + + + account + account name + string + + + accountid + account id + long + + + domain + domain id + long + + + name + usage type name + string + + + quota + quota consumed + bigdecimal + + + type + usage type + int + + + unit + usage unit + string + + + false + + + updateLBStickinessPolicy + Updates load balancer stickiness policy + true + 4.4 + + + id + id of lb stickiness policy + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the policy to the end user or not + false + 4.4 + boolean + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + listPods + Lists all Pods. + false + + + allocationstate + list pods by allocation state + false + string + + + id + list Pods by ID + false + uuid + + + keyword + List by keyword + false + string + + + name + list Pods by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the pods + false + boolean + + + zoneid + list Pods by Zone ID + false + uuid + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + tag + The tag for the capacity type + 4.20.0 + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + deleteTungstenFabricAddressGroup + delete Tungsten-Fabric address group + true + + + addressgroupuuid + the uuid of Tungsten-Fabric address group + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaTariffList + Lists all quota tariff plans + false + 4.7.0 + + + enddate + The end date of the quota tariff. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone. + false + 4.18.0.0 + date + + + id + The quota tariff's id. + false + string + + + keyword + List by keyword + false + string + + + listall + False will list only not removed quota tariffs. If set to true, we will list all, including the removed ones. The default is false. + false + 4.18.0.0 + boolean + + + listonlyremoved + If set to true, we will list only the removed tariffs. The default is false. + false + boolean + + + name + The name of the quota tariff. + false + 4.18.0.0 + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + The start date of the quota tariff. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "00:00:00"). If the recommended format is not used, the date will be considered in the server timezone. + false + date + + + usagetype + Usage type of the resource + false + integer + + + + + id + the ID of the tariff + string + + + activationRule + activation rule of the quota tariff + string + + + currency + currency + string + + + description + description + string + + + effectiveDate + the start date of the quota tariff + date + + + endDate + the end date of the quota tariff + date + + + name + name + string + + + position + position in the execution sequence for tariffs of the same type + integer + + + removed + when the quota tariff was removed + date + + + tariffValue + tariffValue + bigdecimal + + + usageDiscriminator + usageDiscriminator + string + + + usageName + usageName + string + + + usageType + usageType + int + + + usageTypeDescription + usage type description + string + + + usageUnit + usageUnit + string + + + false + + + stopKubernetesCluster + Stops a running CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSnapshots + Lists all available snapshots for the account. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + lists snapshot by snapshot ID + false + uuid + + + ids + the IDs of the snapshots, mutually exclusive with id + false + list + 4.9 + list + + + imagestoreid + ID of the image or image cache store + false + 4.19 + uuid + + + intervaltype + valid values are HOURLY, DAILY, WEEKLY, and MONTHLY. + false + string + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + locationtype + list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty + false + 4.19.0 + string + + + name + lists snapshot by snapshot name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showunique + If set to false, list templates across zones and their storages + false + 4.19.0 + boolean + + + snapshottype + valid values are MANUAL or RECURRING. + false + string + + + storageid + ID of the storage pool + false + 4.19 + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + volumeid + the ID of the disk volume + false + uuid + + + zoneid + list snapshots by zone id + false + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addAccountToProject + Adds account to a project + true + 3.0.0 + + + projectid + ID of the project to add the account to + true + uuid + + + account + name of the account to be added to the project + false + string + + + email + email to which invitation to the project is going to be sent + false + string + + + projectroleid + ID of the project role + false + uuid + + + roletype + Project role type to be assigned to the user - Admin/Regular; default: Regular + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listIpv4SubnetsForZone + Lists IPv4 subnets for zone. + false + 4.20.0 + + + account + the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID which the IPv4 subnet is dedicated to. + false + uuid + + + id + UUID of the IPv4 subnet. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + project who which the IPv4 subnet is dedicated to + false + uuid + + + subnet + CIDR of the IPv4 subnet. + false + string + + + zoneid + UUID of zone to which the IPv4 subnet belongs to. + false + uuid + + + + + id + id of the guest IPv4 subnet + string + + + account + the account of the IPv4 subnet + string + + + created + date when this IPv4 subnet was created. + date + + + domain + the domain name of the IPv4 subnet + string + + + domainid + the domain ID of the IPv4 subnet + string + + + project + the project name of the IPv4 subnet + string + + + projectid + the project id of the IPv4 subnet + string + + + subnet + guest IPv4 subnet + string + + + zoneid + id of zone to which the IPv4 subnet belongs to. + string + + + zonename + name of zone to which the IPv4 subnet belongs to. + string + + + false + + + migrateResourceToAnotherSecondaryStorage + migrates resources from one secondary storage to destination image store + true + 4.19.0 + + + destpool + id of the destination secondary storage pool to which the resources are to be migrated + true + uuid + + + srcpool + id of the image store from where the data is to be migrated + true + uuid + + + snapshots + id(s) of the snapshots to be migrated + false + list + list + + + templates + id(s) of the templates to be migrated + false + list + list + + + + + message + Response message from migration of secondary storage data objects + string + + + migrationtype + Type of migration requested for + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSSHKeyPair + Deletes a keypair by name + false + + + name + Name of the keypair + true + string + + + account + the account associated with the keypair. Must be used with the domainId parameter. + false + string + + + domainid + the domain ID associated with the keypair + false + uuid + + + projectid + the project associated with keypair + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + searchLdap + Searches LDAP based on the username attribute + false + 4.2.0 + + + query + query to search using + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + conflictingusersource + The authentication source for this user as known to the system or empty if the user is not yet in cloudstack. + string + + + domain + The user's domain + string + + + email + The user's email + string + + + firstname + The user's firstname + string + + + lastname + The user's lastname + string + + + principal + The user's principle + string + + + username + The user's username + string + + + false + + + readyForShutdown + Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown + false + 4.19.0 + + + managementserverid + the uuid of the management server + false + uuid + + + + + managementserverid + The id of the management server + long + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + createTungstenFabricLogicalRouter + create Tungsten-Fabric logical router + true + + + name + Tungsten-Fabric logical router name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + startSharedFileSystem + Start a Shared FileSystem + true + 4.20.0 + + + id + the ID of the shared filesystem + true + uuid + + + + + id + ID of the shared filesystem + string + + + account + the account associated with the shared filesystem + string + + + description + description of the shared filesystem + string + + + diskioread + the read (IO) of disk on the shared filesystem + long + + + diskiowrite + the write (IO) of disk on the shared filesystem + long + + + diskkbsread + the shared filesystem's disk read in KiB + long + + + diskkbswrite + the shared filesystem's disk write in KiB + long + + + diskofferingdisplaytext + disk offering display text for the shared filesystem + string + + + diskofferingid + disk offering ID for the shared filesystem + string + + + diskofferingname + disk offering for the shared filesystem + string + + + domain + the domain associated with the shared filesystem + string + + + domainid + the ID of the domain associated with the shared filesystem + string + + + domainpath + path of the domain to which the shared filesystem + string + + + filesystem + the filesystem format + string + + + iscustomdiskoffering + disk offering for the shared filesystem has custom size + boolean + + + name + name of the shared filesystem + string + + + networkid + Network ID of the shared filesystem + string + + + networkname + Network name of the shared filesystem + string + + + path + path to mount the shared filesystem + string + + + physicalsize + the bytes actually consumed on disk + long + + + project + the project name of the shared filesystem + string + + + projectid + the project ID of the shared filesystem + string + + + provider + the shared filesystem provider + string + + + provisioningtype + provisioning type used in the shared filesystem + string + + + serviceofferingid + service offering ID for the shared filesystem + string + + + serviceofferingname + service offering for the shared filesystem + string + + + size + size of the shared filesystem + long + + + sizegb + size of the shared filesystem in GiB + string + + + state + the state of the shared filesystem + string + + + storage + name of the storage pool hosting the data volume + string + + + storageid + ID of the storage pool hosting the data volume + string + + + utilization + the disk utilization + string + + + virtualmachineid + ID of the storage fs vm + string + + + virtualsize + the bytes allocated + long + + + vmstate + ID of the storage fs vm + string + + + volumeid + ID of the storage fs data volume + string + + + volumename + name of the storage fs data volume + string + + + zoneid + ID of the availability zone + string + + + zonename + Name of the availability zone + string + + + nic(*) + the list of nics associated with the shared filesystem + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + list + + + false + + + createTungstenFabricFirewallRule + create Tungsten-Fabric firewall + true + + + action + Tungsten-Fabric firewall rule action + true + string + + + direction + Tungsten-Fabric firewall rule direction + true + string + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + true + string + + + name + Tungsten-Fabric firewall rule name + true + string + + + sequence + the sequence of Tungsten-Fabric firewall rule + true + integer + + + servicegroupuuid + Tungsten-Fabric firewall rule service group uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + destaddressgroupuuid + Tungsten-Fabric firewall rule destination address group uuid + false + string + + + destnetworkuuid + the uuid of Tungsten-Fabric destination network + false + string + + + desttaguuid + Tungsten-Fabric firewall rule destination tag uuid + false + string + + + srcaddressgroupuuid + Tungsten-Fabric firewall rule source address group uuid + false + string + + + srcnetworkuuid + the uuid of Tungsten-Fabric source network + false + string + + + srctaguuid + Tungsten-Fabric firewall rule source tag uuid + false + string + + + tagtypeuuid + Tungsten-Fabric firewall rule tag type uuid + false + string + + + + + action + Tungsten-Fabric firewall rule action + string + + + destaddressgroup + Tungsten-Fabric firewall rule destination address group + string + + + destnetwork + Tungsten-Fabric firewall rule destination network + string + + + desttag + Tungsten-Fabric firewall rule destination tag + string + + + direction + Tungsten-Fabric firewall rule direction + string + + + name + Tungsten-Fabric firewall rule name + string + + + servicegroup + Tungsten-Fabric firewall rule service group + string + + + srcaddressgroup + Tungsten-Fabric firewall rule source address group + string + + + srcnetwork + Tungsten-Fabric firewall rule source network + string + + + srctag + Tungsten-Fabric firewall rule source tag + string + + + tagtype + Tungsten-Fabric firewall rule tag type + string + + + uuid + Tungsten-Fabric firewall rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listConfigurations + Lists all configurations. + false + + + accountid + the ID of the Account to update the parameter value for corresponding account + false + uuid + + + category + lists configurations by category + false + string + + + clusterid + the ID of the Cluster to update the parameter value for corresponding cluster + false + uuid + + + domainid + the ID of the Domain to update the parameter value for corresponding domain + false + uuid + + + group + lists configuration by group name (primarily used for UI) + false + 4.18.0 + string + + + imagestoreuuid + the ID of the Image Store to update the parameter value for corresponding image store + false + uuid + + + keyword + List by keyword + false + string + + + name + lists configuration by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + parent + lists configuration by parent name (primarily used for UI) + false + 4.18.0 + string + + + storageid + the ID of the Storage pool to update the parameter value for corresponding storage pool + false + uuid + + + subgroup + lists configuration by subgroup name (primarily used for UI) + false + 4.18.0 + string + + + zoneid + the ID of the Zone to update the parameter value for corresponding zone + false + uuid + + + + + id + the value of the configuration + long + + + category + the category of the configuration + string + + + component + the component of the configuration + 4.18.0 + string + + + defaultvalue + the default value of the configuration + 4.18.0 + string + + + description + the description of the configuration + string + + + displaytext + the display text of the configuration + 4.18.0 + string + + + group + the group of the configuration + 4.18.0 + string + + + isdynamic + true if the configuration is dynamic + boolean + + + name + the name of the configuration + string + + + options + the possible options of the configuration value + 4.18.0 + string + + + parent + the name of the parent configuration + 4.18.0 + string + + + scope + scope(zone/cluster/pool/account) of the parameter that needs to be updated + string + + + subgroup + the subgroup of the configuration + 4.18.0 + string + + + type + the type of the configuration value + 4.18.0 + string + + + value + the value of the configuration + string + + + false + + + stopNetScalerVpx + Stops a NetScalervm. + true + + + id + the ID of the NetScaler vm + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + scaleKubernetesCluster + Scales a created, running or stopped CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + false + boolean + + + maxsize + Maximum number of worker nodes in the cluster + false + long + + + minsize + Minimum number of worker nodes in the cluster + false + long + + + nodeids + the IDs of the nodes to be removed + false + list + list + + + serviceofferingid + the ID of the service offering for the virtual machines in the cluster. + false + uuid + + + size + number of Kubernetes cluster nodes + false + long + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + deleteInstanceGroup + Deletes a vm group + false + + + id + the ID of the instance group + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateTrafficType + Updates traffic type of a physical network + true + 3.0.0 + + + id + traffic type id + true + uuid + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a Hyperv host + false + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + false + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + false + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + false + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + false + string + + + + + id + id of the network provider + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a HyperV host + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + string + + + physicalnetworkid + the physical network this belongs to + string + + + traffictype + the trafficType to be added to the physical network + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + string + + + false + + + listConditions + List Conditions for VM auto scaling + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + counterid + Counter-id of the condition. + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + ID of the Condition. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + policyid + the ID of the policy + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + the id of the Condition + string + + + account + the owner of the Condition. + string + + + counter + Details of the Counter. + counterresponse + + + counterid + the Id of the Counter. + string + + + countername + the Name of the Counter. + string + + + domain + the domain name of the owner. + string + + + domainid + the domain id of the Condition owner + string + + + domainpath + path of the domain to which the Condition owner belongs + 4.19.2.0 + string + + + project + the project name of the Condition + string + + + projectid + the project id of the Condition. + string + + + relationaloperator + Relational Operator to be used with threshold. + string + + + threshold + Threshold Value for the counter. + long + + + zoneid + zone id of counter + string + + + false + + + addBackupRepository + Adds a backup repository to store NAS backups + false + 4.20.0 + + + address + address of the backup repository + true + string + + + name + name of the backup repository + true + string + + + type + type of the backup repository storage. Supported values: nfs, cephfs, cifs + true + string + + + zoneid + ID of the zone where the backup repository is to be added + true + uuid + + + capacitybytes + capacity of this backup repository + false + long + + + mountopts + shared storage mount options + false + string + + + provider + backup repository provider + false + string + + + + + id + the ID of the backup repository + string + + + address + the address / url of the backup repository + string + + + capacitybytes + capacity of the backup repository + long + + + created + the date and time the backup repository was added + date + + + mountopts + mount options for the backup repository + string + + + name + the name of the backup repository + string + + + provider + name of the provider + string + + + type + backup type + string + + + zoneid + the Zone ID of the backup repository + string + + + zonename + the Zone name of the backup repository + string + + + false + + + migrateSecondaryStorageData + migrates data objects from one secondary storage to destination image store(s) + true + 4.15.0 + + + destpools + id(s) of the destination secondary storage pool(s) to which the templates are to be migrated + true + list + list + + + srcpool + id of the image store from where the data is to be migrated + true + uuid + + + migrationtype + Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete + false + string + + + + + message + Response message from migration of secondary storage data objects + string + + + migrationtype + Type of migration requested for + string + + + success + true if operation is executed successfully + boolean + + + false + + + destroyVolume + Destroys a Volume. + true + 4.14.0 + + + id + The ID of the volume + true + uuid + + + expunge + If true is passed, the volume is expunged immediately. False by default. + false + 4.6.0 + boolean + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addTrafficType + Adds traffic type to a physical network + true + 3.0.0 + + + physicalnetworkid + the Physical Network ID + true + uuid + + + traffictype + the trafficType to be added to the physical network + true + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a Hyperv host + false + string + + + isolationmethod + Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'. + false + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + false + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + false + string + + + vlan + The VLAN id to be used for Management traffic by VMware host + false + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + false + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + false + string + + + + + id + id of the network provider + string + + + hypervnetworklabel + The network name label of the physical device dedicated to this traffic on a HyperV host + string + + + kvmnetworklabel + The network name label of the physical device dedicated to this traffic on a KVM host + string + + + ovm3networklabel + The network name of the physical device dedicated to this traffic on an OVM3 host + string + + + physicalnetworkid + the physical network this belongs to + string + + + traffictype + the trafficType to be added to the physical network + string + + + vmwarenetworklabel + The network name label of the physical device dedicated to this traffic on a VMware host + string + + + xennetworklabel + The network name label of the physical device dedicated to this traffic on a XenServer host + string + + + false + + + listSecondaryStorageSelectors + Lists the secondary storage selectors and their rules. + false + 4.19.0 + + + zoneid + The zone ID to be used in the search filter. + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + showremoved + Show removed heuristics. + false + boolean + + + type + Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + false + string + + + + + id + ID of the heuristic. + string + + + created + When the heuristic was created. + date + + + description + Description of the heuristic. + string + + + heuristicrule + The heuristic rule, in JavaScript language, used to select a secondary storage to be directed. + string + + + name + Name of the heuristic. + string + + + removed + When the heuristic was removed. + date + + + type + The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME. + string + + + zoneid + The zone which the heuristic is valid upon. + string + + + false + + + listLoadBalancerRuleInstances + List all virtual machine instances that are assigned to a load balancer rule. + false + + + id + the ID of the load balancer rule + true + uuid + + + applied + true if listing all virtual machines currently applied to the load balancer rule; default is true + false + boolean + + + keyword + List by keyword + false + string + + + lbvmips + true if load balancer rule VM IP information to be included; default is false + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + + + lbvmipaddresses + IP addresses of the vm set of lb rule + list + + + loadbalancerruleinstance + the user vm set for lb rule + uservmresponse + + + false + + + deleteCondition + Removes a condition for VM auto scaling + true + + + id + the ID of the condition. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updatePhysicalNetwork + Updates a physical network + true + 3.0.0 + + + id + physical network id + true + uuid + + + networkspeed + the speed for the physical network[1G/10G] + false + string + + + state + Enabled/Disabled + false + string + + + tags + Tag the physical network + false + list + list + + + vlan + the VLAN for the physical network + false + string + + + + + id + the uuid of the physical network + string + + + broadcastdomainrange + Broadcast domain range of the physical network + string + + + domainid + the domain id of the physical network owner + string + + + isolationmethods + isolation methods + string + + + name + name of the physical network + string + + + networkspeed + the speed of the physical network + string + + + state + state of the physical network + string + + + tags + comma separated tag + string + + + vlan + the vlan of the physical network + string + + + zoneid + zone id of the physical network + string + + + zonename + zone name of the physical network + string + + + false + + + stopSharedFileSystem + Stop a Shared FileSystem + true + 4.20.0 + + + id + the ID of the shared filesystem + true + uuid + + + forced + Force stop the shared filesystem. + false + boolean + + + + + id + ID of the shared filesystem + string + + + account + the account associated with the shared filesystem + string + + + description + description of the shared filesystem + string + + + diskioread + the read (IO) of disk on the shared filesystem + long + + + diskiowrite + the write (IO) of disk on the shared filesystem + long + + + diskkbsread + the shared filesystem's disk read in KiB + long + + + diskkbswrite + the shared filesystem's disk write in KiB + long + + + diskofferingdisplaytext + disk offering display text for the shared filesystem + string + + + diskofferingid + disk offering ID for the shared filesystem + string + + + diskofferingname + disk offering for the shared filesystem + string + + + domain + the domain associated with the shared filesystem + string + + + domainid + the ID of the domain associated with the shared filesystem + string + + + domainpath + path of the domain to which the shared filesystem + string + + + filesystem + the filesystem format + string + + + iscustomdiskoffering + disk offering for the shared filesystem has custom size + boolean + + + name + name of the shared filesystem + string + + + networkid + Network ID of the shared filesystem + string + + + networkname + Network name of the shared filesystem + string + + + path + path to mount the shared filesystem + string + + + physicalsize + the bytes actually consumed on disk + long + + + project + the project name of the shared filesystem + string + + + projectid + the project ID of the shared filesystem + string + + + provider + the shared filesystem provider + string + + + provisioningtype + provisioning type used in the shared filesystem + string + + + serviceofferingid + service offering ID for the shared filesystem + string + + + serviceofferingname + service offering for the shared filesystem + string + + + size + size of the shared filesystem + long + + + sizegb + size of the shared filesystem in GiB + string + + + state + the state of the shared filesystem + string + + + storage + name of the storage pool hosting the data volume + string + + + storageid + ID of the storage pool hosting the data volume + string + + + utilization + the disk utilization + string + + + virtualmachineid + ID of the storage fs vm + string + + + virtualsize + the bytes allocated + long + + + vmstate + ID of the storage fs vm + string + + + volumeid + ID of the storage fs data volume + string + + + volumename + name of the storage fs data volume + string + + + zoneid + ID of the availability zone + string + + + zonename + Name of the availability zone + string + + + nic(*) + the list of nics associated with the shared filesystem + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + list + + + false + + + createTungstenFabricManagementNetwork + create Tungsten-Fabric management network + false + + + podid + the ID of pod + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricFirewallRule + list Tungsten-Fabric firewall rule + false + + + firewallpolicyuuid + the uuid of Tungsten-Fabric firewall policy + false + string + + + firewallruleuuid + the uuid of Tungsten-Fabric firewall rule + false + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + action + Tungsten-Fabric firewall rule action + string + + + destaddressgroup + Tungsten-Fabric firewall rule destination address group + string + + + destnetwork + Tungsten-Fabric firewall rule destination network + string + + + desttag + Tungsten-Fabric firewall rule destination tag + string + + + direction + Tungsten-Fabric firewall rule direction + string + + + name + Tungsten-Fabric firewall rule name + string + + + servicegroup + Tungsten-Fabric firewall rule service group + string + + + srcaddressgroup + Tungsten-Fabric firewall rule source address group + string + + + srcnetwork + Tungsten-Fabric firewall rule source network + string + + + srctag + Tungsten-Fabric firewall rule source tag + string + + + tagtype + Tungsten-Fabric firewall rule tag type + string + + + uuid + Tungsten-Fabric firewall rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createProject + Creates a project + true + 3.0.0 + + + name + name of the project + true + string + + + account + account who will be Admin for the project + false + string + + + accountid + ID of the account owning a project + false + uuid + + + displaytext + The display text of the project, defaults to the 'name´. + false + string + + + domainid + domain ID of the account owning a project + false + uuid + + + userid + user ID of the account to be assigned as owner of the project i.e., Project Admin + false + 4.15.0 + uuid + + + + + id + the id of the project + string + + + cpuavailable + the total number of cpu cores available to be created for this project + 4.2.0 + string + + + cpulimit + the total number of cpu cores the project can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by project + 4.2.0 + long + + + created + the date this project was created + 4.16.0 + date + + + displaytext + the displaytext of the project + string + + + domain + the domain name where the project belongs to + string + + + domainid + the domain id the project belongs to + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this project to acquire + 4.2.0 + string + + + iplimit + the total number of public ip addresses this project can acquire + 4.2.0 + string + + + iptotal + the total number of public ip addresses allocated for this project + 4.2.0 + long + + + memoryavailable + the total memory (in MB) available to be created for this project + 4.2.0 + string + + + memorylimit + the total memory (in MB) the project can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by project + 4.2.0 + long + + + name + the name of the project + string + + + networkavailable + the total number of networks available to be created for this project + 4.2.0 + string + + + networklimit + the total number of networks the project can own + 4.2.0 + string + + + networktotal + the total number of networks owned by project + 4.2.0 + long + + + owner + the account name of the project's owners + list + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the project can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by project + 4.2.0 + long + + + projectaccountname + the project account name of the project + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this project + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the project can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by project + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this project + 4.2.0 + string + + + snapshotlimit + the total number of snapshots which can be stored by this project + 4.2.0 + string + + + snapshottotal + the total number of snapshots stored by this project + 4.2.0 + long + + + state + the state of the project + string + + + taggedresources + The tagged resource limit and count for the project + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this project + 4.2.0 + string + + + templatelimit + the total number of templates which can be created by this project + 4.2.0 + string + + + templatetotal + the total number of templates which have been created by this project + 4.2.0 + long + + + vmavailable + the total number of virtual machines available for this project to acquire + 4.2.0 + string + + + vmlimit + the total number of virtual machines that can be deployed by this project + 4.2.0 + string + + + vmrunning + the total number of virtual machines running for this project + 4.2.0 + integer + + + vmstopped + the total number of virtual machines stopped for this project + 4.2.0 + integer + + + vmtotal + the total number of virtual machines deployed by this project + 4.2.0 + long + + + volumeavailable + the total volume available for this project + 4.2.0 + string + + + volumelimit + the total volume which can be used by this project + 4.2.0 + string + + + volumetotal + the total volume being used by this project + 4.2.0 + long + + + vpcavailable + the total number of vpcs available to be created for this project + 4.2.0 + string + + + vpclimit + the total number of vpcs the project can own + 4.2.0 + string + + + vpctotal + the total number of vpcs owned by project + 4.2.0 + long + + + tags(*) + the list of resource tags associated with vm + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + addCiscoVnmcResource + Adds a Cisco Vnmc Controller + false + + + hostname + Hostname or ip address of the Cisco VNMC Controller. + true + string + + + password + Credentials to access the Cisco VNMC Controller API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + username + Credentials to access the Cisco VNMC Controller API + true + string + + + + false + + + assignCertToLoadBalancer + Assigns a certificate to a load balancer rule + true + + + certid + the ID of the certificate + true + uuid + + + lbruleid + the ID of the load balancer rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + markDefaultZoneForAccount + Marks a default zone for this account + true + 4.0 + + + account + Name of the account that is to be marked. + true + string + + + domainid + Marks the account that belongs to the specified domain. + true + uuid + + + zoneid + The Zone ID with which the account is to be marked. + true + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + taggedresources + The tagged resource limit and count for the account + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + revokeCertificate + Revokes certificate using configured CA plugin + true + 4.11.0 + + + serial + The certificate serial number, as a hex value + true + string + + + cn + The certificate CN + false + string + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteRoutingFirewallRule + Deletes a routing firewall rule + true + 4.20.0 + + + id + the ID of the Routing firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + changeServiceForSystemVm + Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect. + false + + + id + The ID of the system vm + true + uuid + + + serviceofferingid + the service offering ID to apply to the system vm + true + uuid + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + updateSiocInfo + Update SIOC info + false + 4.11.0 + + + iopsnotifythreshold + Notify if IOPS above this value + true + integer + + + limitiopspergb + Limit IOPS per GB + true + integer + + + sharespergb + Shares per GB + true + integer + + + storageid + Storage Pool ID + true + uuid + + + zoneid + Zone ID + true + uuid + + + + + msg + The return message from the operation ('Success' if successful) + string + + + false + + + cloudianSsoLogin + Generates single-sign-on login url for logged-in CloudStack user to access the Cloudian Management Console + false + 4.11.0 + + + + url + the sso redirect url + string + + + false + + + deleteVMSnapshot + Deletes a vmsnapshot. + true + 4.2.0 + + + vmsnapshotid + The ID of the VM snapshot + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + unmanageVirtualMachine + Unmanage a guest virtual machine. + true + 4.15.0 + + + id + The ID of the virtual machine to unmanage + true + uuid + + + + + details + details of the unmanage VM operation + string + + + success + result of the unmanage VM operation + boolean + + + false + + + rebootRouter + Starts a router. + true + + + id + the ID of the router + true + uuid + + + forced + Force reboot the router (Router is force Stopped and then Started) + false + 4.16.0 + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listNics + list the vm nics IP to NIC + false + + + virtualmachineid + the ID of the vm + true + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + keyword + List by keyword + false + string + + + networkid + list nic of the specific vm's network + false + uuid + + + nicid + the ID of the nic to list IPs + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + false + + + listBgpPeers + Lists Bgp Peers. + false + 4.20.0 + + + account + the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter. + false + string + + + asnumber + AS number of the Bgp Peer. + false + long + + + domainid + the domain ID which the Bgp Peer is dedicated to. + false + uuid + + + id + UUID of the Bgp Peer. + false + uuid + + + isdedicated + Lists only dedicated or non-dedicated Bgp Peers. If not set, lists all dedicated and non-dedicated BGP peers the domain/account can access. + false + boolean + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + project who which the Bgp Peer is dedicated to + false + uuid + + + zoneid + UUID of zone to which the Bgp Peer belongs to. + false + uuid + + + + + id + id of the bgp peer + string + + + account + the account of the bgp peer + string + + + asnumber + AS number of bgp peer + long + + + created + date when this bgp peer was created. + date + + + details + additional key/value details of the bgp peer + map + + + domain + the domain name of the bgp peer + string + + + domainid + the domain ID of the bgp peer + string + + + ip6address + IPv6 address of bgp peer + string + + + ipaddress + IPv4 address of bgp peer + string + + + password + password of bgp peer + string + + + project + the project name of the bgp peer + string + + + projectid + the project id of the bgp peer + string + + + zoneid + id of zone to which the bgp peer belongs to. + string + + + zonename + name of zone to which the bgp peer belongs to. + string + + + false + + + createSnapshotFromVMSnapshot + Creates an instant snapshot of a volume from existing vm snapshot. + true + 4.10.0 + + + vmsnapshotid + The ID of the VM snapshot + true + uuid + + + volumeid + The ID of the disk volume + true + uuid + + + name + the name of the snapshot + false + string + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listImageStoreObjects + Lists objects at specified path on an image store. + false + 4.19.0 + + + id + id of the image store + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + path to list on image store + false + string + + + + + format + Format of template associated with the data store object. + string + + + isdirectory + Is it a directory. + boolean + + + lastupdated + Last modified date of the file/directory. + date + + + name + Name of the data store object. + string + + + size + Size is in Bytes. + long + + + snapshotid + Snapshot ID associated with the data store object. + string + + + snapshotname + Snapshot Name associated with the data store object. + string + + + templateid + Template ID associated with the data store object. + string + + + templatename + Template Name associated with the data store object. + string + + + volumeid + Volume ID associated with the data store object. + string + + + volumename + Volume Name associated with the data store object. + string + + + false + + + dedicateGuestVlanRange + Dedicates a guest vlan range to an account + false + + + physicalnetworkid + physical network ID of the vlan + true + uuid + + + vlanrange + guest vlan range to be dedicated + true + string + + + account + account who will own the VLAN + false + string + + + domainid + domain ID of the account owning a VLAN + false + uuid + + + projectid + project who will own the VLAN + false + uuid + + + + + id + the ID of the guest VLAN range + string + + + account + the account of the guest VLAN range + string + + + domain + the domain name of the guest VLAN range + string + + + domainid + the domain ID of the guest VLAN range + string + + + domainpath + path of the domain to which the guest VLAN range belongs + 4.19.2.0 + string + + + guestvlanrange + the guest VLAN range + string + + + physicalnetworkid + the physical network of the guest vlan range + long + + + project + the project name of the guest vlan range + string + + + projectid + the project id of the guest vlan range + string + + + zoneid + the zone of the guest vlan range + long + + + false + + + updateIso + Updates an ISO file. + false + + + id + the ID of the image file + true + uuid + + + arch + the CPU arch of the template/ISO. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteCounter + Deletes a counter for VM auto scaling + true + + + id + the ID of the counter + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + issueCertificate + Issues a client certificate using configured or provided CA plugin + true + 4.11.0 + + + csr + The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered + false + string + + + domain + Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN + false + string + + + duration + Certificate validity duration in number of days, when not provided the default configured value will be used + false + integer + + + ipaddress + Comma separated list of IP addresses, the certificate should be issued for + false + string + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + cacertificates + The CA certificate(s) + string + + + certificate + The client certificate + string + + + privatekey + Private key for the certificate + string + + + false + + + createPortForwardingRule + Creates a port forwarding rule + true + + + ipaddressid + the IP address id of the port forwarding rule + true + uuid + + + privateport + the starting port of port forwarding rule's private port range + true + integer + + + protocol + the protocol for the port forwarding rule. Valid values are TCP or UDP. + true + string + + + publicport + the starting port of port forwarding rule's public port range + true + integer + + + virtualmachineid + the ID of the virtual machine for the port forwarding rule + true + uuid + + + cidrlist + the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use. + false + list + list + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + networkid + the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case). + false + uuid + + + openfirewall + if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true + false + boolean + + + privateendport + the ending port of port forwarding rule's private port range + false + integer + + + publicendport + the ending port of port forwarding rule's private port range + false + integer + + + vmguestip + VM guest nic secondary IP address for the port forwarding rule + false + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + prepareTemplate + load template into primary storage + false + + + templateid + template ID of the template to be prepared in primary storage(s). + true + uuid + + + zoneid + zone ID of the template to be prepared in primary storage(s). + true + uuid + + + storageid + storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools. + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + dedicateZone + Dedicates a zones. + true + + + domainid + the ID of the containing domain + true + uuid + + + zoneid + the ID of the zone + true + uuid + + + account + the name of the account which needs dedication. Must be used with domainId. + false + string + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Zone is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the zone + string + + + domainid + the domain ID to which the Zone is dedicated + string + + + zoneid + the ID of the Zone + string + + + zonename + the Name of the Zone + string + + + false + + + updateBackupOffering + Updates a backup offering. + false + 4.16.0 + + + id + The ID of the Backup Offering to be updated + true + uuid + + + allowuserdrivenbackups + Whether to allow user driven backups or not + false + boolean + + + description + The description of the Backup Offering to be updated + false + string + + + name + The name of the Backup Offering to be updated + false + string + + + + + id + ID of the backup offering + string + + + allowuserdrivenbackups + whether offering allows user driven ad-hoc/scheduled backups + boolean + + + created + the date this backup offering was created + date + + + description + description for the backup offering + string + + + externalid + external ID on the provider side + string + + + name + name for the backup offering + string + + + zoneid + zone ID + string + + + zonename + zone name + string + + + false + + + listBuckets + Lists all Buckets. + false + 4.19.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the bucket + false + uuid + + + ids + the IDs of the Buckets, mutually exclusive with id + false + list + list + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the bucket + false + string + + + objectstorageid + the ID of the object storage pool, available to ROOT admin only + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + ID of the Bucket + string + + + accesskey + Bucket Access Key + string + + + account + the account associated with the Bucket + string + + + created + the date the Bucket was created + date + + + domain + the domain associated with the bucket + string + + + domainid + the ID of the domain associated with the bucket + string + + + domainpath + path of the domain to which the bucket belongs + 4.19.2.0 + string + + + encryption + Bucket Encryption + boolean + + + name + name of the Bucket + string + + + objectlocking + Bucket Object Locking + boolean + + + objectstorageid + id of the object storage hosting the Bucket; returned to admin user only + string + + + objectstore + Name of the object storage hosting the Bucket; returned to admin user only + string + + + policy + Bucket Access Policy + string + + + project + the project name of the bucket + string + + + projectid + the project id of the bucket + string + + + provider + Object storage provider + string + + + quota + Bucket Quota in GB + integer + + + size + Total size of objects in Bucket + long + + + state + State of the Bucket + string + + + url + Bucket URL + string + + + usersecretkey + Bucket Secret Key + string + + + versioning + Bucket Versioning + boolean + + + false + + + stopInternalLoadBalancerVM + Stops an Internal LB vm. + true + + + id + the ID of the internal lb vm + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateSecurityGroup + Updates a security group + false + 4.14.0.0 + + + id + The ID of the security group. + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + name + The new name of the security group. + false + string + + + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + samlSso + SP initiated SAML Single Sign On + false + + + idpid + Identity Provider Entity ID + true + string + + + + + account + the account name the user belongs to + string + + + domainid + Domain ID that the user belongs to + string + + + firstname + first name of the user + string + + + is2faenabled + Is two factor authentication enabled + 4.18.0.0 + string + + + is2faverified + Is two factor authentication verified + 4.18.0.0 + string + + + issuerfor2fa + Two factor authentication issuer + 4.18.0.0 + string + + + lastname + last name of the user + string + + + providerfor2fa + Two factor authentication provider + 4.18.0.0 + string + + + registered + Is user registered + string + + + sessionkey + Session key that can be passed in subsequent Query command calls + string + + + timeout + the time period before the session has expired + integer + + + timezone + user time zone + string + + + timezoneoffset + user time zoneoffset + string + + + type + the account type (admin, domain-admin, read-only-admin, user) + string + + + userid + User ID + string + + + username + Username + string + + + false + + + createDomain + Creates a domain + false + + + name + creates domain with this name + true + string + + + domainid + Domain UUID, required for adding domain from another Region + false + string + + + networkdomain + Network domain for networks in the domain + false + string + + + parentdomainid + assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed. + false + uuid + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + taggedresources + The tagged resource limit and count for the domain + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + addImageStore + Adds backup image store. + false + 4.2.0 + + + provider + the image store provider name + true + string + + + details + the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + name + the name for the image store + false + string + + + url + the URL for the image store + false + string + + + zoneid + the Zone ID for the image store + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + revokeTemplateDirectDownloadCertificate + Revoke a direct download certificate from hosts in a zone + false + 4.13 + + + zoneid + (optional) zone to revoke certificate + true + uuid + + + hostid + (optional) the host ID to revoke certificate + false + uuid + + + hypervisor + (optional) hypervisor type + false + string + + + id + id of the certificate + false + uuid + + + name + (optional) alias of the SSL certificate + false + string + + + + + details + indicates the details in case of failure or host skipped + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + status + indicates if the certificate has been revoked from the host, failed or skipped + string + + + false + + + updateStorageCapabilities + Syncs capabilities of storage pools + false + 4.16.0 + + + id + Storage pool id + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listNsxControllers + list all NSX controllers added to CloudStack + false + 4.19.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + NSX controller added to the specific zone + false + uuid + + + + + edgecluster + The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX + string + + + hostname + NSX controller hostname or IP address + string + + + name + NSX controller name + string + + + nsxprovideruuid + NSX controller ID + string + + + port + NSX controller port + string + + + tier0gateway + The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks + string + + + transportzone + The name of the transport zone. A transport zone controls to which hosts a logical switch can reach + string + + + zoneid + Zone ID to which the NSX controller is associated with + string + + + zonename + Zone name to which the NSX controller is associated with + string + + + false + + + deleteUserData + Deletes a userdata + false + 4.18 + + + id + the ID of the Userdata + true + uuid + + + account + an optional account for the userdata. Must be used with domainId. + false + string + + + domainid + an optional domainId for the userdata. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the userdata + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + assignVolume + Changes ownership of a Volume from one account to another. + false + 4.18.0.0 + + + volumeid + The ID of the volume to be reassigned. + true + uuid + + + accountid + The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'. + false + uuid + + + projectid + The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'. + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listSupportedNetworkServices + Lists all network services provided by CloudStack or for the given Provider. + false + 3.0.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + provider + network service provider name + false + string + + + service + network service name to list providers and capabilities of + false + string + + + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + false + + + revokeSecurityGroupIngress + Deletes a particular ingress rule from this security group + true + + + id + The ID of the ingress rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addNetworkServiceProvider + Adds a network serviceProvider to a physical network + true + 3.0.0 + + + name + the name for the physical network service provider + true + string + + + physicalnetworkid + the Physical Network ID to add the provider to + true + uuid + + + destinationphysicalnetworkid + the destination Physical Network ID to bridge to + false + uuid + + + servicelist + the list of services to be enabled for this physical network service provider + false + list + list + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + quotaTariffDelete + Marks a quota tariff as removed. + false + 4.18.0.0 + + + id + ID of the quota tariff + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteVpnGateway + Delete site to site vpn gateway + true + + + id + id of customer gateway + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createServiceOffering + Creates a service offering. + false + + + name + the name of the service offering + true + string + + + bytesreadrate + bytes read rate of the disk offering + false + long + + + bytesreadratemax + burst bytes read rate of the disk offering + false + long + + + bytesreadratemaxlength + length (in seconds) of the burst + false + long + + + byteswriterate + bytes write rate of the disk offering + false + long + + + byteswriteratemax + burst bytes write rate of the disk offering + false + long + + + byteswriteratemaxlength + length (in seconds) of the burst + false + long + + + cachemode + the cache mode to use for this disk offering. none, writeback or writethrough + false + 4.14 + string + + + cpunumber + the CPU number of the service offering + false + integer + + + cpuspeed + For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz. +For the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning. + false + integer + + + customized + Whether service offering size is custom or not + false + 4.13 + boolean + + + customizediops + whether compute offering iops is custom or not + false + 4.4 + boolean + + + deploymentplanner + The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used + false + string + + + diskofferingid + the ID of the disk offering to which service offering should be mapped + false + 4.17 + uuid + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + false + 4.17 + boolean + + + displaytext + The display text of the service offering, defaults to 'name'. + false + string + + + domainid + the ID of the containing domain(s), null for public offerings + false + list + list + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + false + 4.16 + boolean + + + encryptroot + VMs using this offering require root volume encryption + false + 4.18 + boolean + + + hosttags + the host tag for this service offering. + false + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + false + 4.4 + integer + + + iopsreadrate + io requests read rate of the disk offering + false + long + + + iopsreadratemax + burst requests read rate of the disk offering + false + long + + + iopsreadratemaxlength + length (in seconds) of the burst + false + long + + + iopswriterate + io requests write rate of the disk offering + false + long + + + iopswriteratemax + burst io requests write rate of the disk offering + false + long + + + iopswriteratemaxlength + length (in seconds) of the burst + false + long + + + issystem + is this a system vm offering + false + boolean + + + isvolatile + true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM + false + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + false + boolean + + + maxcpunumber + The maximum number of CPUs to be set with Custom Computer Offering + false + 4.13 + integer + + + maxiops + max iops of the compute offering + false + 4.4 + long + + + maxmemory + The maximum memory size of the custom service offering in MB + false + 4.13 + integer + + + memory + the total memory of the service offering in MB + false + integer + + + mincpunumber + The minimum number of CPUs to be set with Custom Computer Offering + false + 4.13 + integer + + + miniops + min iops of the compute offering + false + 4.4 + long + + + minmemory + The minimum memory size of the custom service offering in MB + false + 4.13 + integer + + + networkrate + data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtype + false + integer + + + offerha + the HA for the service offering + false + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + false + string + + + purgeresources + Whether to cleanup instance and its associated resource from database upon expunge of the instance + false + 4.20 + boolean + + + rootdisksize + the Root disk size in GB. + false + 4.15 + long + + + serviceofferingdetails + details for planner, used to store specific parameters + false + map + map + + + storagepolicy + Name of the storage policy defined at vCenter, this is applicable only for VMware + false + 4.15 + uuid + + + storagetype + the storage type of the service offering. Values are local and shared. + false + string + + + systemvmtype + the system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm". + false + string + + + tags + the tags for this service offering. + false + string + + + zoneid + the ID of the containing zone(s), null for public offerings + false + list + 4.13 + list + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + purgeresources + Whether to cleanup VM and its associated resource upon expunge + 4.20 + boolean + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + state + state of the service offering + string + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + assignVirtualMachine + Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain. + false + 3.0.0 + + + virtualmachineid + id of the VM to be moved + true + uuid + + + account + account name of the new VM owner. + false + string + + + domainid + domain id of the new VM owner. + false + uuid + + + networkids + list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created. + false + list + list + + + projectid + an optional project for the new VM owner. + false + uuid + + + securitygroupids + list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group. + false + list + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVmsForImport + Lists virtual machines on a unmanaged host + false + 4.19.0 + + + host + the host name or IP address + true + string + + + hypervisor + hypervisor type of the host + true + string + + + zoneid + the zone ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + password + the password for the host + false + string + + + username + the username for the host + false + string + + + + + clusterid + the ID of the cluster to which virtual machine belongs + string + + + clustername + the name of the cluster to which virtual machine belongs + string + + + cpucorepersocket + the CPU cores per socket for the virtual machine. VMware specific + integer + + + cpunumber + the CPU cores of the virtual machine + integer + + + cpuspeed + the CPU speed of the virtual machine + integer + + + hostid + the ID of the host to which virtual machine belongs + string + + + hostname + the name of the host to which virtual machine belongs + string + + + memory + the memory of the virtual machine in MB + integer + + + name + the name of the virtual machine + string + + + osdisplayname + the operating system of the virtual machine + string + + + osid + the operating system ID of the virtual machine + string + + + powerstate + the power state of the virtual machine + string + + + disk(*) + the list of disks associated with the virtual machine + + + id + the ID of the disk + string + + + capacity + the capacity of the disk in bytes + long + + + controller + the controller of the disk + string + + + controllerunit + the controller unit of the disk + integer + + + datastorehost + the controller of the disk + string + + + datastorename + the controller of the disk + string + + + datastorepath + the controller of the disk + string + + + datastoretype + the controller of the disk + string + + + imagepath + the file path of the disk image + string + + + label + the label of the disk + string + + + position + the position of the disk + integer + + + set + + + nic(*) + the list of nics associated with the virtual machine + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + configureNetscalerLoadBalancer + configures a netscaler load balancer device + true + + + lbdeviceid + Netscaler load balancer device ID + true + uuid + + + inline + true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall + false + boolean + + + lbdevicecapacity + capacity of the device, Capacity will be interpreted as number of networks device can handle + false + long + + + lbdevicededicated + true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts + false + boolean + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + false + list + list + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + deleteTungstenFabricServiceGroup + delete Tungsten-Fabric service group + true + + + servicegroupuuid + the uuid of Tungsten-Fabric service group + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addObjectStoragePool + Adds a object storage pool + false + 4.19.0 + + + name + the name for the object store + true + string + + + provider + the object store provider name + true + string + + + url + the URL for the object store + true + string + + + details + the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss + false + map + map + + + tags + the tags for the storage pool + false + string + + + + + id + the ID of the object store + string + + + name + the name of the object store + string + + + providername + the provider name of the object store + string + + + storagetotal + the total size of the object store + long + + + storageused + the object store currently used size + long + + + url + the url of the object store + string + + + false + + + deleteUserFromProject + Deletes user from the project + true + 4.15.0 + + + projectid + ID of the project to remove the user from + true + uuid + + + userid + Id of the user to be removed from the project + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkServiceProvider + Deletes a Network Service Provider. + true + 3.0.0 + + + id + the ID of the network service provider + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listNetworkDevice + List network devices + false + + + keyword + List by keyword + false + string + + + networkdeviceparameterlist + parameters for network device + false + map + map + + + networkdevicetype + Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the network device + string + + + false + + + listProjectRoles + Lists Project roles in CloudStack + false + 4.15.0 + + + projectid + List project role by project ID. + true + uuid + + + keyword + List by keyword + false + string + + + name + List project role by project role name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectroleid + List project role by project role ID. + false + uuid + + + + + projectid + the id of the project + string + + + false + + + deleteOpenDaylightController + Removes an OpenDyalight controler + true + + + id + OpenDaylight Controller ID + true + uuid + + + + + id + device id of the controller + string + + + name + the name assigned to the controller + string + + + physicalnetworkid + the physical network to which this controller belongs to + string + + + url + the url of the controller api + string + + + username + the username to authenticate to the controller + string + + + false + + + updateTemplate + Updates attributes of a template. + false + + + id + the ID of the image file + true + uuid + + + arch + the CPU arch of the template/ISO. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + 4.20.0 + string + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + string + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createVlanIpRange + Creates a VLAN IP range. + false + + + account + account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted + false + string + + + domainid + domain ID of the account owning a VLAN + false + uuid + + + endip + the ending IP address in the VLAN IP range + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + fornsx + true if the IP range is used for NSX resource + false + 4.20.0 + boolean + + + forsystemvms + true if IP range is set to system vms, false if not + false + boolean + + + forvirtualnetwork + true if VLAN is of Virtual type, false if Direct + false + boolean + + + gateway + the gateway of the VLAN IP range + false + string + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6gateway + the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC + false + string + + + netmask + the netmask of the VLAN IP range + false + string + + + networkid + the network id + false + uuid + + + physicalnetworkid + the physical network id + false + uuid + + + podid + optional parameter. Have to be specified for Direct Untagged vlan only. + false + uuid + + + projectid + project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted + false + uuid + + + startip + the beginning IP address in the VLAN IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + vlan + the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged + false + string + + + zoneid + the Zone ID of the VLAN IP range + false + uuid + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + fornsx + indicates whether IP range is dedicated to NSX resources or not + boolean + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + updateVpnConnection + Updates site to site vpn connection + true + 4.4 + + + id + id of vpn connection + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the connection ID + string + + + account + the owner + string + + + cidrlist + guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). + string + + + created + the date and time the host was created + date + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + dpd + if DPD is enabled for customer gateway + boolean + + + esplifetime + Lifetime of ESP SA of customer gateway + long + + + esppolicy + ESP policy of the customer gateway + string + + + forceencap + if Force NAT Encapsulation is enabled for customer gateway + boolean + + + fordisplay + is connection for display to the regular user + 4.4 + boolean + + + gateway + public ip address id of the customer gateway + string + + + ikelifetime + Lifetime of IKE SA of customer gateway + long + + + ikepolicy + IKE policy of the customer gateway + string + + + ikeversion + Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike + string + + + ipsecpsk + IPsec Preshared-Key of the customer gateway + string + + + passive + State of vpn connection + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + s2scustomergatewayid + the customer gateway ID + string + + + s2svpngatewayid + the vpn gateway ID + string + + + splitconnections + Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. + boolean + + + state + State of vpn connection + string + + + false + + + listPaloAltoFirewallNetworks + lists network that are using Palo Alto firewall device + false + + + lbdeviceid + palo alto balancer device ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + asnumber + AS NUMBER + 4.20.0 + long + + + asnumberid + UUID of AS NUMBER + 4.20.0 + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + bgppeers + The BGP peers for the network + 4.20.0 + set + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip4routes + The routes for the network to ease adding route in upstream router + 4.20.0 + set + + + ip4routing + The IPv4 routing type of network + 4.20.0 + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The Ipv6 routing type of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getPathForVolume + Get the path associated with the provided volume UUID + false + + + volumeid + CloudStack Volume UUID + true + string + + + + + path + The path field for the volume + string + + + false + + + listTungstenFabricPolicyRule + list Tungsten-Fabric policy + false + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + ruleuuid + the uuid of Tungsten-Fabric rule + false + string + + + zoneid + the ID of zone + false + uuid + + + + + action + Tungsten-Fabric policy action + string + + + destendport + Tungsten-Fabric policy destination end port + int + + + destipprefix + Tungsten-Fabric policy destination ip prefix + string + + + destipprefixlen + Tungsten-Fabric policy destination ip prefix length + int + + + destnetwork + Tungsten-Fabric policy destination network + string + + + deststartport + Tungsten-Fabric policy destination start port + int + + + direction + Tungsten-Fabric policy name + string + + + policyuuid + Tungsten-Fabric policy uuid + string + + + protocol + Tungsten-Fabric policy protocol + string + + + srcendport + Tungsten-Fabric policy source end port + int + + + srcipprefix + Tungsten-Fabric policy source ip prefix + string + + + srcipprefixlen + Tungsten-Fabric policy source ip prefix length + int + + + srcnetwork + Tungsten-Fabric policy source network + string + + + srcstartport + Tungsten-Fabric policy source start port + int + + + uuid + Tungsten-Fabric rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + deleteTungstenFabricPolicy + delete Tungsten-Fabric policy + true + + + policyuuid + the Uuid of Tungsten-Fabric tag type + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listManagementServers + Lists management servers. + false + + + id + the id of the management server + false + uuid + + + keyword + List by keyword + false + string + + + name + the name of the management server + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the management server + string + + + javadistribution + the java distribution name running the management server process + string + + + javaversion + the version of the java distribution running the management server process + string + + + kernelversion + the running OS kernel version for this Management Server + string + + + lastboottime + the last time the host on which this Management Server runs was booted + date + + + lastserverstart + the last time this Management Server was started + date + + + lastserverstop + the last time this Management Server was stopped + date + + + name + the name of the management server + string + + + osdistribution + the name of the OS distribution running on the management server + string + + + serviceip + the IP Address for this Management Server + string + + + state + the state of the management server + state + + + version + the version of the management server + string + + + false + + + updateInstanceGroup + Updates a vm group + false + + + id + Instance group ID + true + uuid + + + name + new instance group name + false + string + + + + + id + the ID of the instance group + string + + + account + the account owning the instance group + string + + + created + time and date the instance group was created + date + + + domain + the domain name of the instance group + string + + + domainid + the domain ID of the instance group + string + + + domainpath + path of the Domain the instance group belongs to + 4.19.2.0 + string + + + name + the name of the instance group + string + + + project + the project name of the instance group + string + + + projectid + the project ID of the instance group + string + + + false + + + listTemplateDirectDownloadCertificates + List the uploaded certificates for direct download templates + false + 4.17.0 + + + id + list direct download certificate by ID + false + uuid + + + keyword + List by keyword + false + string + + + listhosts + if set to true: include the hosts where the certificate is uploaded to + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the zone where certificates are uploaded + false + uuid + + + + + id + the direct download certificate id + string + + + alias + the direct download certificate alias + string + + + hostsmap + the hosts where the certificate is uploaded to + list + + + hypervisor + the hypervisor of the hosts where the certificate is uploaded + string + + + issuer + the direct download certificate issuer + string + + + serialnum + the direct download certificate serial num + string + + + subject + the direct download certificate subject + string + + + validity + the direct download certificate issuer + string + + + version + the direct download certificate version + string + + + zoneid + the zone id where the certificate is uploaded + string + + + zonename + the zone name where the certificate is uploaded + string + + + false + + + listUcsManagers + List ucs manager + false + + + id + the ID of the ucs manager + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the zone id + false + uuid + + + + + id + the ID of the ucs manager + string + + + name + the name of ucs manager + string + + + url + the url of ucs manager + string + + + zoneid + the zone ID of ucs manager + string + + + false + + + changeServiceForRouter + Upgrades domain router to a new service offering + false + + + id + The ID of the router + true + uuid + + + serviceofferingid + the service offering ID to apply to the domain router + true + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + updateVolume + Updates the volume. + true + + + chaininfo + The chain info of the volume + false + 4.4 + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + deleteprotection + Set delete protection for the volume. If true, The volume will be protected from deletion. Note: If the volume is managed by another service like autoscaling groups or CKS, delete protection will be ignored. + false + 4.20.0 + boolean + + + displayvolume + an optional field, whether to the display the volume to the end user or not. + false + boolean + + + id + the ID of the disk volume + false + uuid + + + name + new name of the volume + false + 4.16 + string + + + path + The path of the volume + false + string + + + state + The state of the volume + false + 4.3 + string + + + storageid + Destination storage pool UUID for the volume + false + 4.3 + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listTrafficTypes + Lists traffic types of a given physical network. + false + 3.0.0 + + + physicalnetworkid + the Physical Network ID + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + false + + + updateVirtualMachine + Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call. + false + + + id + The ID of the virtual machine + true + uuid + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + deleteprotection + Set delete protection for the virtual machine. If true, the instance will be protected from deletion. Note: If the instance is managed by another service like autoscaling groups or CKS, delete protection will be ignored. + false + 4.20.0 + boolean + + + details + Details in key/value pairs. 'extraconfig' is not allowed to be passed in details. + false + map + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + displayname + user generated name + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + group of the virtual machine + false + string + + + haenable + true if high-availability is enabled for the virtual machine, false otherwise + false + boolean + + + instancename + instance name of the user vm + false + 4.4 + string + + + isdynamicallyscalable + true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting + false + boolean + + + name + new host name of the vm. The VM has to be stopped/started for this update to take affect + false + 4.4 + string + + + ostypeid + the ID of the OS type that best represents this VM. + false + uuid + + + securitygroupids + list of security group ids to be applied on the virtual machine. + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + 4.16.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the userdata + false + 4.18 + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateAccount + Updates account information for the authenticated user + false + + + account + Current account name + false + string + + + accountdetails + Details for the account used to store specific parameters + false + map + map + + + domainid + The UUID of the domain where the account exists + false + uuid + + + id + Account UUID + false + uuid + + + networkdomain + Network domain for the account's networks; empty string will update domainName with NULL value + false + string + + + newname + New name for the account + false + string + + + roleid + The UUID of the dynamic role to set for the account + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + taggedresources + The tagged resource limit and count for the account + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + addSecondaryStorage + Adds secondary storage. + false + + + url + the URL for the secondary storage + true + string + + + zoneid + the Zone ID for the secondary storage + false + uuid + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + disableAccount + Disables an account + true + + + lock + If true, only lock the account; else disable the account + true + boolean + + + account + Disables specified account. + false + string + + + domainid + Disables specified account in this domain. + false + uuid + + + id + Account id + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + taggedresources + The tagged resource limit and count for the account + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + listDomains + Lists domains and provides detailed information for listed domains + false + + + details + comma separated list of domain details requested, value can be a list of [ all, resource, min] + false + list + list + + + id + List domain by domain ID. + false + uuid + + + keyword + List by keyword + false + string + + + level + List domains by domain level. + false + integer + + + listall + 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 + false + boolean + + + name + List domain by domain name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for domains + false + boolean + + + tag + Tag for resource type to return usage + false + 4.20.0 + string + + + + + id + the ID of the domain + string + + + cpuavailable + the total number of cpu cores available to be created for this domain + 4.2.0 + string + + + cpulimit + the total number of cpu cores the domain can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by domain + 4.2.0 + long + + + created + the date when this domain was created + date + + + domaindetails + details for the domain + map + + + haschild + whether the domain has one or more sub-domains + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this domain to acquire + string + + + iplimit + the total number of public ip addresses this domain can acquire + string + + + iptotal + the total number of public ip addresses allocated for this domain + long + + + level + the level of the domain + integer + + + memoryavailable + the total memory (in MB) available to be created for this domain + 4.2.0 + string + + + memorylimit + the total memory (in MB) the domain can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by domain + 4.2.0 + long + + + name + the name of the domain + string + + + networkavailable + the total number of networks available to be created for this domain + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the domain can own + 3.0.1 + string + + + networktotal + the total number of networks owned by domain + 3.0.1 + long + + + parentdomainid + the domain ID of the parent domain + string + + + parentdomainname + the domain name of the parent domain + string + + + path + the path of the domain + string + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the domain can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by domain + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this domain + 3.0.1 + string + + + projectlimit + the total number of projects the domain can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this domain + 3.0.1 + long + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this domain + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the domain can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by domain + 4.2.0 + float + + + snapshotavailable + the total number of snapshots available for this domain + string + + + snapshotlimit + the total number of snapshots which can be stored by this domain + string + + + snapshottotal + the total number of snapshots stored by this domain + long + + + state + the state of the domain + string + + + taggedresources + The tagged resource limit and count for the domain + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this domain + string + + + templatelimit + the total number of templates which can be created by this domain + string + + + templatetotal + the total number of templates which have been created by this domain + long + + + vmavailable + the total number of virtual machines available for this domain to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this domain + string + + + vmtotal + the total number of virtual machines deployed by this domain + long + + + volumeavailable + the total volume available for this domain + string + + + volumelimit + the total volume which can be used by this domain + string + + + volumetotal + the total volume being used by this domain + long + + + vpcavailable + the total number of vpcs available to be created for this domain + 4.0.0 + string + + + vpclimit + the total number of vpcs the domain can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by domain + 4.0.0 + long + + + false + + + resetUserDataForVirtualMachine + Resets the UserData for virtual machine. The virtual machine must be in a "Stopped" state. [async] + false + + + id + The ID of the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + an optional project for the virtual machine + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + map + + + userdataid + the ID of the userdata + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listNetworkACLLists + Lists all network ACLs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists network ACL with the specified ID. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list network ACLs by specified name + false + string + + + networkid + list network ACLs by network ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vpcid + list network ACLs by VPC ID + false + uuid + + + + + id + the ID of the ACL + string + + + description + Description of the ACL + string + + + fordisplay + is ACL for display to the regular user + 4.4 + boolean + + + name + the Name of the ACL + string + + + vpcid + Id of the VPC this ACL is associated with + string + + + vpcname + Name of the VPC this ACL is associated with + string + + + false + + + deleteTemplate + Deletes a template from the system. All virtual machines using the deleted template will not be affected. + true + + + id + the ID of the template + true + uuid + + + forced + Force delete a template. + false + 4.9+ + boolean + + + issystem + Necessary if the template's type is system. + false + 4.20.0 + boolean + + + zoneid + the ID of zone of the template + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + archiveSnapshot + Archives (moves) a snapshot on primary storage to secondary storage + true + + + id + The ID of the snapshot + true + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateVpnGateway + Updates site to site vpn local gateway + true + 4.4 + + + id + id of customer gateway + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the vpn to the end user or not + false + 4.4 + boolean + + + + + id + the vpn gateway ID + string + + + account + the owner + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpn gateway for display to the regular user + 4.4 + boolean + + + project + the project name + string + + + projectid + the project id + string + + + publicip + the public IP address + string + + + removed + the date and time the host was removed + date + + + vpcid + the vpc id of this gateway + string + + + vpcname + the vpc name of this gateway + 4.13.2 + string + + + false + + + releaseDedicatedGuestVlanRange + Releases a dedicated guest vlan range to the system + true + + + id + the ID of the dedicated guest vlan range + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteSecurityGroup + Deletes security group + false + + + account + the account of the security group. Must be specified with domain ID + false + string + + + domainid + the domain ID of account owning the security group + false + uuid + + + id + The ID of the security group. Mutually exclusive with name parameter + false + uuid + + + name + The ID of the security group. Mutually exclusive with id parameter + false + string + + + projectid + the project of the security group + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + importVolume + Import an unmanaged volume from a storage pool on a host into CloudStack + true + 4.19.1 + + + path + the path of the volume + true + string + + + storageid + the ID of the storage pool + true + uuid + + + account + an optional account for the volume. Must be used with domainId. + false + string + + + diskofferingid + the ID of the disk offering linked to the volume + false + uuid + + + domainid + import volume to the domain specified + false + uuid + + + name + the name of the volume. If not set, it will be set to the path of the volume. + false + string + + + projectid + import volume for the project + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createTemplate + Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it. + true + + + name + the name of the template + true + string + + + ostypeid + the ID of the OS Type that best represents the OS of this template. + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + 4.19.0 + string + + + bits + 32 or 64 bit + false + integer + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + The display text of the template, defaults to the 'name'. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + 4.19.0 + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if this template is a public template, false otherwise + false + boolean + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + create template for the project + false + uuid + + + requireshvm + true if the template requires HVM, false otherwise + false + boolean + + + snapshotid + the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in + false + uuid + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + url + Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server + false + string + + + virtualmachineid + Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal + false + uuid + + + volumeid + the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in + false + uuid + + + zoneid + the zone for the template. Can be specified with snapshot only + false + 4.19.0 + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + restoreBackup + Restores an existing stopped or deleted VM using a VM backup + true + 4.14.0 + + + id + ID of the backup + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + uploadCustomCertificate + Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself. + true + + + certificate + The certificate to be uploaded. + true + string + + + domainsuffix + DNS domain suffix that the certificate is granted for. + true + string + + + id + An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3 + false + integer + + + name + A name / alias for the certificate. + false + string + + + privatekey + The private key for the attached certificate. + false + string + + + + + message + message of the certificate upload operation + string + + + false + + + listDedicatedClusters + Lists dedicated clusters. + false + + + account + the name of the account associated with the cluster. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated clusters by affinity group + false + uuid + + + clusterid + the ID of the cluster + false + uuid + + + domainid + the ID of the domain associated with the cluster + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the cluster + string + + + affinitygroupid + the Dedication Affinity Group ID of the cluster + string + + + clusterid + the ID of the cluster + string + + + clustername + the name of the cluster + string + + + domainid + the domain ID of the cluster + string + + + false + + + quotaUpdate + Update quota calculations, alerts and statements + false + 4.7.0 + + + + updated_on + timestamp when the run got over + date + + + false + + + listTungstenFabricNetwork + list Tungsten-Fabric network + false + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false + false + boolean + + + networkuuid + the uuid of Tungsten-Fabric network + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric network name + string + + + uuid + Tungsten-Fabric network uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listTrafficMonitors + List traffic monitor Hosts. + false + + + zoneid + zone Id + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the external firewall + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + releaseBgpPeer + Releases an existing dedicated Bgp Peer. + true + 4.20.0 + + + id + Id of the Bgp Peer + true + uuid + + + + + id + id of the bgp peer + string + + + account + the account of the bgp peer + string + + + asnumber + AS number of bgp peer + long + + + created + date when this bgp peer was created. + date + + + details + additional key/value details of the bgp peer + map + + + domain + the domain name of the bgp peer + string + + + domainid + the domain ID of the bgp peer + string + + + ip6address + IPv6 address of bgp peer + string + + + ipaddress + IPv4 address of bgp peer + string + + + password + password of bgp peer + string + + + project + the project name of the bgp peer + string + + + projectid + the project id of the bgp peer + string + + + zoneid + id of zone to which the bgp peer belongs to. + string + + + zonename + name of zone to which the bgp peer belongs to. + string + + + false + + + updatePortForwardingRule + Updates a port forwarding rule. Only the private port and the virtual machine can be updated. + true + + + id + the ID of the port forwarding rule + true + 4.4 + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + privateendport + the private end port of the port forwarding rule + false + integer + + + privateport + the private start port of the port forwarding rule + false + integer + + + virtualmachineid + the ID of the virtual machine for the port forwarding rule + false + uuid + + + vmguestip + VM guest nic Secondary ip address for the port forwarding rule + false + 4.5 + string + + + + + id + the ID of the port forwarding rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + fordisplay + is firewall for display to the regular user + 4.4 + boolean + + + ipaddress + the public ip address for the port forwarding rule + string + + + ipaddressid + the public ip address id for the port forwarding rule + string + + + networkid + the id of the guest network the port forwarding rule belongs to + string + + + privateendport + the ending port of port forwarding rule's private port range + string + + + privateport + the starting port of port forwarding rule's private port range + string + + + protocol + the protocol of the port forwarding rule + string + + + publicendport + the ending port of port forwarding rule's private port range + string + + + publicport + the starting port of port forwarding rule's public port range + string + + + state + the state of the rule + string + + + virtualmachinedisplayname + the VM display name for the port forwarding rule + string + + + virtualmachineid + the VM ID for the port forwarding rule + string + + + virtualmachinename + the VM name for the port forwarding rule + string + + + vmguestip + the vm ip address for the port forwarding rule + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + associateIpAddress + Acquires and associates a public IP to an account. + true + + + account + the account to associate with this IP address + false + string + + + domainid + the ID of the domain to associate with this IP address + false + uuid + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + 4.4 + boolean + + + ipaddress + IP Address to be associated + false + string + + + isportable + should be set to true if public IP is required to be transferable across zones, if not specified defaults to false + false + boolean + + + networkid + The network this IP address should be associated to. + false + uuid + + + projectid + Deploy VM for the project + false + uuid + + + regionid + region ID from where portable IP is to be associated. + false + integer + + + vpcid + the VPC you want the IP address to be associated with + false + uuid + + + zoneid + the ID of the availability zone you want to acquire an public IP address from + false + uuid + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forsystemvms + true if range is dedicated for System VMs + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + getSolidFireVolumeAccessGroupIds + Get the SF Volume Access Group IDs + false + + + clusterid + Cluster UUID + true + string + + + storageid + Storage Pool UUID + true + string + + + + + solidFireVolumeAccessGroupIds + SolidFire Volume Access Group Ids + long[] + + + false + + + deleteVpnConnection + Delete site to site vpn connection + true + + + id + id of vpn connection + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAlertTypes + Lists all alerts types + false + + + + id + the id of the alert + string + + + description + description of the alert + string + + + name + the name of the alert + 4.3 + string + + + sent + the date and time the alert was sent + date + + + type + One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29 + short + + + false + + + resetSSHKeyForVirtualMachine + Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async] + true + + + id + The ID of the virtual machine + true + uuid + + + account + an optional account for the ssh key. Must be used with domainId. + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs to be used to login to the virtual machine + false + list + 4.17 + list + + + projectid + an optional project for the ssh key + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteManagementNetworkIpRange + Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated. + true + 4.11.0.0 + + + endip + The ending IP address. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + startip + The starting IP address. + true + string + + + vlan + The vlan id the ip range sits on + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createNetworkACL + Creates a ACL rule in the given network (the network has to belong to VPC) + true + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + true + string + + + aclid + The network of the VM the ACL will be created for + false + uuid + + + action + scl entry action, allow or deny + false + string + + + cidrlist + the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of ACL + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + networkid + The network of the VM the ACL will be created for + false + uuid + + + number + The number of the ACL item, its ordering + false + integer + + + reason + A description indicating why the ACL rule is required. + false + string + + + startport + the starting port of ACL + false + integer + + + traffictype + the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + addKubernetesSupportedVersion + Add a supported Kubernetes version + false + + + mincpunumber + the minimum number of CPUs to be set with the Kubernetes version + true + integer + + + minmemory + the minimum RAM size in MB to be set with the Kubernetes version + true + integer + + + semanticversion + the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format + true + string + + + arch + the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + checksum + the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + directdownload + If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false + false + 4.18.2 + boolean + + + name + the name of the Kubernetes supported version + false + string + + + url + the URL of the binaries ISO for Kubernetes supported version + false + string + + + zoneid + the ID of the zone in which Kubernetes supported version will be available + false + uuid + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + directdownload + KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage + 4.18.2 + boolean + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + linkUserDataToTemplate + Link or unlink a userdata to a template. + false + 4.18.0 + + + isoid + the ID of the ISO for the virtual machine + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + userdataid + the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO + false + uuid + + + userdatapolicy + an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride + false + string + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listGlobalLoadBalancerRules + Lists load balancer rules. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the global load balancer rule + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + regionid + region ID + false + integer + + + tags + List resources by tags (key/value pairs) + false + map + map + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + deleteDiskOffering + Updates a disk offering. + false + + + id + ID of the disk offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getKubernetesClusterConfig + Get Kubernetes cluster config + false + + + id + the ID of the Kubernetes cluster + false + uuid + + + + + id + the id of the container cluster + string + + + configdata + the config data of the cluster + string + + + name + Name of the container cluster + string + + + false + + + releaseDedicatedCluster + Release the dedication for cluster + true + + + clusterid + the ID of the Cluster + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteAutoScalePolicy + Deletes a autoscale policy. + true + + + id + the ID of the autoscale policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteRole + Deletes a role + false + 4.9.0 + + + id + ID of the role + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteCiscoNexusVSM + delete a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listInternalLoadBalancerVMs + List internal LB VMs. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fetchhealthcheckresults + if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false + false + 4.14 + boolean + + + forvpc + if true is passed for this parameter, list only VPC Internal LB VMs + false + boolean + + + hostid + the host ID of the Internal LB VM + false + uuid + + + id + the ID of the Internal LB VM + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the Internal LB VM + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the Internal LB VM + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + the state of the Internal LB VM + false + string + + + vpcid + List Internal LB VMs by VPC + false + uuid + + + zoneid + the Zone ID of the Internal LB VM + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listCiscoVnmcResources + Lists Cisco VNMC controllers + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + resourceid + Cisco VNMC resource ID + false + uuid + + + + false + + + executeClusterDrsPlan + Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail. + true + 4.19.0 + + + id + ID of cluster + true + uuid + + + migrateto + Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=<uuid>&migrateto[vm-index].host=<uuid> Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm=<uuid> indicates the UUID of the vm that you want to migrate, and host=<uuid> indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc> + false + map + map + + + + + id + unique ID of the drs plan for cluster + string + + + clusterid + Id of the cluster + string + + + eventid + Start event Id of the DRS Plan + string + + + migrations + List of migrations + list + + + status + Status of DRS Plan + status + + + type + Type of DRS Plan (Automated or Manual)) + type + + + false + + + revokeSecurityGroupEgress + Deletes a particular egress rule from this security group + true + 3.0.0 + + + id + The ID of the egress rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + uploadResourceIcon + Uploads an icon for the specified resource(s) + false + 4.16.0.0 + + + base64image + Base64 string representation of the resource icon/image + true + string + + + resourceids + list of resources to upload the icon/image for + true + list + list + + + resourcetype + type of the resource + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateKubernetesSupportedVersion + Update a supported Kubernetes version + false + + + id + the ID of the Kubernetes supported version + true + uuid + + + state + the enabled or disabled state of the Kubernetes supported version + true + string + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + directdownload + KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage + 4.18.2 + boolean + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + deleteIpv4SubnetForZone + Deletes an existing IPv4 subnet for a zone. + true + 4.20.0 + + + id + Id of the guest network IPv4 subnet + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createGuestNetworkIpv6Prefix + Creates a guest network IPv6 prefix. + true + 4.17.0.0 + + + prefix + The /56 or higher IPv6 CIDR for network prefix. + true + string + + + zoneid + UUID of zone to which the IPv6 prefix belongs to. + true + uuid + + + + + id + id of the guest IPv6 prefix + string + + + availablesubnets + count of the available IPv6 subnets for the prefix. + integer + + + created + date when this IPv6 prefix was created. + date + + + prefix + guest IPv6 prefix + string + + + totalsubnets + count of the total IPv6 subnets for the prefix. + integer + + + usedsubnets + count of the used IPv6 subnets for the prefix. + integer + + + zoneid + id of zone to which the IPv6 prefix belongs to. + string + + + false + + + createRole + Creates a role + false + 4.9.0 + + + name + Creates a role with this unique name + true + string + + + description + The description of the role + false + string + + + ispublic + Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true. + false + boolean + + + roleid + ID of the role to be cloned from. Either roleid or type must be passed in + false + uuid + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + state + the state of the role + string + + + type + the type of the role + string + + + false + + + getUploadParamsForVolume + Upload a data disk to the cloudstack cloud. + false + 4.6.0 + + + format + the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume/template/iso + true + string + + + zoneid + the ID of the zone the volume/template/iso is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + checksum + the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + diskofferingid + the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown. + false + uuid + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + imagestoreuuid + Image store uuid + false + string + + + projectid + Upload volume/template/iso for the project + false + uuid + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + updateAutoScaleVmProfile + Updates an existing autoscale vm profile. + true + + + id + the ID of the autoscale vm profile + true + uuid + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + false + uuid + + + counterparam + counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161 + false + map + map + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + false + integer + + + fordisplay + an optional field, whether to the display the profile to the end user or not + false + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. +Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 . +Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". + false + map + 4.18.0 + map + + + serviceofferingid + the service offering of the auto deployed virtual machine + false + 4.18.0 + uuid + + + templateid + the template of the auto deployed virtual machine + false + uuid + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + 4.18.0 + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18.1 + map + + + userdataid + the ID of the userdata + false + 4.18.1 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + domainpath + path of the domain to which the vm profile belongs + 4.19.2.0 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base64 encoded VM user data + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.1 + string + + + userdataid + the id of userdata used for the VM + 4.18.1 + string + + + userdataname + the name of userdata used for the VM + 4.18.1 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.1 + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + enableAutoScaleVmGroup + Enables an AutoScale Vm Group + true + + + id + the ID of the autoscale group + true + uuid + + + + + id + the autoscale vm group ID + string + + + account + the account owning the vm group + string + + + associatednetworkid + the id of the guest network the lb rule belongs to + string + + + associatednetworkname + the name of the guest network the lb rule belongs to + string + + + availablevirtualmachinecount + the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup + 4.18.0 + int + + + created + the date when this vm group was created + date + + + domain + the domain name of the vm group + string + + + domainid + the domain ID of the vm group + string + + + domainpath + path of the domain to which the vm group belongs + 4.19.2.0 + string + + + fordisplay + is group for display to the regular user + 4.4 + boolean + + + interval + the frequency at which the conditions have to be evaluated + int + + + lbprovider + the lb provider of the guest network the lb rule belongs to + string + + + lbruleid + the load balancer rule ID + string + + + maxmembers + the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number. + int + + + minmembers + the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number. + int + + + name + the name of the autoscale vm group + string + + + privateport + the private port + string + + + project + the project name of the vm group + string + + + projectid + the project id of the vm group + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + scaledownpolicies + list of scaledown autoscale policies + list + + + scaleuppolicies + list of scaleup autoscale policies + list + + + state + the current state of the AutoScale Vm Group + string + + + vmprofileid + the autoscale profile that contains information about the vms in the vm group. + string + + + false + + + listGuestNetworkIpv6Prefixes + Lists guest network IPv6 prefixes + false + 4.17.0 + + + id + UUID of the IPv6 prefix. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + UUID of zone to which the IPv6 prefix belongs to. + false + uuid + + + + + id + id of the guest IPv6 prefix + string + + + availablesubnets + count of the available IPv6 subnets for the prefix. + integer + + + created + date when this IPv6 prefix was created. + date + + + prefix + guest IPv6 prefix + string + + + totalsubnets + count of the total IPv6 subnets for the prefix. + integer + + + usedsubnets + count of the used IPv6 subnets for the prefix. + integer + + + zoneid + id of zone to which the IPv6 prefix belongs to. + string + + + false + + + updateGuestOsMapping + Updates the information about Guest OS to Hypervisor specific name mapping + true + 4.4.0 + + + id + UUID of the Guest OS to hypervisor name Mapping + true + uuid + + + osnameforhypervisor + Hypervisor specific name for this Guest OS + true + string + + + osmappingcheckenabled + When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.) + false + 4.19.0 + boolean + + + + + id + the ID of the Guest OS mapping + string + + + hypervisor + the hypervisor + string + + + hypervisorversion + version of the hypervisor for mapping + string + + + isuserdefined + is the mapping user defined + string + + + osdisplayname + standard display name for the Guest OS + string + + + osnameforhypervisor + hypervisor specific name for the Guest OS + string + + + ostypeid + the ID of the Guest OS type + string + + + false + + + deleteTungstenFabricTag + delete Tungsten-Fabric tag + true + + + taguuid + the uuid of Tungsten-Fabric tag + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateHostPassword + Update password of a host/pool on management server. + false + + + password + the new password for the host/cluster + true + string + + + username + the username for the host/cluster + true + string + + + clusterid + the cluster ID + false + uuid + + + hostid + the host ID + false + uuid + + + update_passwd_on_host + if the password should also be updated on the hosts + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createPortableIpRange + adds a range of portable public IP's to a region + true + 4.2.0 + + + endip + the ending IP address in the portable IP range + true + string + + + gateway + the gateway for the portable IP range + true + string + + + netmask + the netmask of the portable IP range + true + string + + + regionid + Id of the Region + true + integer + + + startip + the beginning IP address in the portable IP range + true + string + + + vlan + VLAN id, if not specified defaulted to untagged + false + string + + + + + id + portable IP range ID + string + + + endip + the end ip of the portable IP range + string + + + gateway + the gateway of the VLAN IP range + string + + + netmask + the netmask of the VLAN IP range + string + + + regionid + Region Id in which portable ip range is provisioned + integer + + + startip + the start ip of the portable IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + portableipaddress(*) + List of portable IP and association with zone/network/vpc details that are part of GSLB rule + + + accountid + the account ID the portable IP address is associated with + string + + + allocated + date the portal IP address was acquired + date + + + domainid + the domain ID the portable IP address is associated with + string + + + ipaddress + public IP address + string + + + networkid + the ID of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + regionid + Region Id in which global load balancer is created + integer + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing and Free + string + + + vpcid + VPC the ip belongs to + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + list + + + false + + + deleteWebhookDelivery + Deletes Webhook delivery + false + 4.20.0 + + + enddate + The end date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having end date equal to or before the specified date will be considered. + false + date + + + id + The ID of the Webhook delivery + false + uuid + + + managementserverid + The ID of the management server + false + uuid + + + startdate + The start date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having start date equal to or after the specified date will be considered. + false + date + + + webhookid + The ID of the Webhook + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateCluster + Updates an existing cluster + false + + + id + the ID of the Cluster + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + arch + the CPU arch of the cluster. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + clustername + the cluster name + false + string + + + clustertype + hypervisor type of the cluster + false + string + + + hypervisor + hypervisor type of the cluster + false + string + + + managedstate + whether this cluster is managed by cloudstack + false + string + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + arch + CPU Arch of the hosts in the cluster + 4.20 + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + tag + The tag for the capacity type + 4.20.0 + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + listVmwareDcVms + Lists the VMs in a VMware Datacenter + false + + + datacentername + Name of VMware datacenter. + false + string + + + existingvcenterid + UUID of a linked existing vCenter + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + password + The password for specified username. + false + string + + + username + The Username required to connect to resource. + false + string + + + vcenter + The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + clusterid + the ID of the cluster to which virtual machine belongs + string + + + clustername + the name of the cluster to which virtual machine belongs + string + + + cpucorepersocket + the CPU cores per socket for the virtual machine. VMware specific + integer + + + cpunumber + the CPU cores of the virtual machine + integer + + + cpuspeed + the CPU speed of the virtual machine + integer + + + hostid + the ID of the host to which virtual machine belongs + string + + + hostname + the name of the host to which virtual machine belongs + string + + + memory + the memory of the virtual machine in MB + integer + + + name + the name of the virtual machine + string + + + osdisplayname + the operating system of the virtual machine + string + + + osid + the operating system ID of the virtual machine + string + + + powerstate + the power state of the virtual machine + string + + + disk(*) + the list of disks associated with the virtual machine + + + id + the ID of the disk + string + + + capacity + the capacity of the disk in bytes + long + + + controller + the controller of the disk + string + + + controllerunit + the controller unit of the disk + integer + + + datastorehost + the controller of the disk + string + + + datastorename + the controller of the disk + string + + + datastorepath + the controller of the disk + string + + + datastoretype + the controller of the disk + string + + + imagepath + the file path of the disk image + string + + + label + the label of the disk + string + + + position + the position of the disk + integer + + + set + + + nic(*) + the list of nics associated with the virtual machine + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listStorageProviders + Lists storage providers. + false + + + type + the type of storage provider: either primary or image + true + string + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + the name of the storage provider + string + + + type + the type of the storage provider: primary or image provider + string + + + false + + + listUcsProfiles + List profile in ucs manager + false + + + ucsmanagerid + the id for the ucs manager + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + ucsdn + ucs profile dn + string + + + false + + + getUserKeys + This command allows the user to query the seceret and API keys for the account + false + 4.10.0 + + + id + ID of the user whose keys are required + true + uuid + + + + + apikey + the api key of the registered user + string + + + secretkey + the secret key of the registered user + string + + + false + + + updateGlobalLoadBalancerRule + update global load balancer rules. + true + + + id + the ID of the global load balancer rule + true + uuid + + + description + the description of the load balancer rule + false + string + + + gslblbmethod + load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin' + false + string + + + gslbstickysessionmethodname + session sticky method (sourceip) if not specified defaults to sourceip + false + string + + + + + id + global load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + description + the description of the global load balancer rule + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + gslbdomainname + DNS domain name given for the global load balancer + string + + + gslblbmethod + Load balancing method used for the global load balancer + string + + + gslbservicetype + GSLB service type + string + + + gslbstickysessionmethodname + session persistence method used for the global load balancer + string + + + name + name of the global load balancer rule + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + regionid + Region Id in which global load balancer is created + integer + + + loadbalancerrule(*) + List of load balancer rules that are part of GSLB rule + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + list + + + false + + + authorizeSamlSso + Allow or disallow a user to use SAML SSO + false + + + enable + If true, authorizes user to be able to use SAML for Single Sign. If False, disable user to user SAML SSO. + true + boolean + + + userid + User uuid + true + uuid + + + entityid + The Identity Provider ID the user is allowed to get single signed on from + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addGuestOs + Add a new guest OS type + true + 4.4.0 + + + oscategoryid + ID of Guest OS category + true + uuid + + + osdisplayname + Unique display name for Guest OS + true + string + + + details + Map of (key/value pairs) + false + map + map + + + forDisplay + whether this guest OS is available for end users + false + boolean + + + name + Optional name for Guest OS + false + string + + + + + id + the ID of the OS type + string + + + description + the name/description of the OS type + string + + + fordisplay + is the guest OS visible for the users + boolean + + + isuserdefined + is the guest OS user defined + boolean + + + name + the name of the OS type + string + + + oscategoryid + the ID of the OS category + string + + + oscategoryname + the name of the OS category + string + + + false + + + listHostTags + Lists host tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the host tag + string + + + hostid + the host ID of the host tag + long + + + isimplicit + true if the host tag is implicit + 4.20.0 + boolean + + + name + the name of the host tag + string + + + false + + + addAnnotation + add an annotation. + false + 4.11 + + + adminsonly + the annotation is visible for admins only + false + 4.16.0 + boolean + + + annotation + the annotation text + false + string + + + entityid + the id of the entity to annotate + false + string + + + entitytype + The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER + false + string + + + + + id + the (uu)id of the annotation + string + + + adminsonly + True if the annotation is available for admins only + boolean + + + annotation + the contents of the annotation + string + + + created + the creation timestamp for this annotation + date + + + entityid + the (uu)id of the entity to which this annotation pertains + string + + + entityname + the name of the entity to which this annotation pertains + string + + + entitytype + the type of the annotated entity + string + + + removed + the removal timestamp for this annotation + date + + + userid + The (uu)id of the user that entered the annotation + string + + + username + The username of the user that entered the annotation + string + + + false + + + listIdps + Returns list of discovered SAML Identity Providers + false + + + + id + The IdP Entity ID + string + + + orgName + The IdP Organization Name + string + + + orgUrl + The IdP Organization URL + string + + + false + + + deployNetscalerVpx + Creates new NS Vpx + true + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + networkid + The network this ip address should be associated to. + false + uuid + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + listElastistorVolume + Lists the volumes of elastistor + false + + + id + the ID of the account + true + string + + + + + id + the id of the volume + string + + + compression + compression + string + + + deduplication + deduplication + string + + + graceallowed + graceallowed + string + + + name + the name of the volume + string + + + sync + synchronization + string + + + false + + + addBaremetalPxeKickStartServer + add a baremetal pxe server + true + + + password + Credentials to reach external pxe device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + pxeservertype + type of pxe device + true + string + + + tftpdir + Tftp root directory of PXE server + true + string + + + url + URL of the external pxe device + true + string + + + username + Credentials to reach external pxe device + true + string + + + podid + Pod Id + false + uuid + + + + + tftpdir + Tftp root directory of PXE server + string + + + false + + + listNiciraNvpDevices + Lists Nicira NVP devices + false + + + keyword + List by keyword + false + string + + + nvpdeviceid + nicira nvp device ID + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + hostname + the controller Ip address + string + + + l2gatewayserviceuuid + this L2 gateway service Uuid + string + + + l3gatewayserviceuuid + this L3 gateway service Uuid + string + + + niciradevicename + device name + string + + + nvpdeviceid + device id of the Nicire Nvp + string + + + physicalnetworkid + the physical network to which this Nirica Nvp belongs to + string + + + provider + name of the provider + string + + + transportzoneuuid + the transport zone Uuid + string + + + false + + + listAlerts + Lists all alerts. + false + + + id + the ID of the alert + false + uuid + + + keyword + List by keyword + false + string + + + name + list by alert name + false + 4.3 + string + + + page + false + integer + + + pagesize + false + integer + + + type + list by alert type + false + string + + + + + id + the id of the alert + string + + + description + description of the alert + string + + + name + the name of the alert + 4.3 + string + + + sent + the date and time the alert was sent + date + + + type + One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29 + short + + + false + + + deployVirtualMachine + Creates and automatically starts a virtual machine based on a service offering, disk offering, and template. + true + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + templateid + the ID of the template for the virtual machine + true + uuid + + + zoneid + availability zone for the virtual machine + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter + false + list + list + + + bootintosetup + Boot into hardware setup or not (ignored if startVm = false, only valid for vmware) + false + 4.15.0.0 + boolean + + + bootmode + Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + boottype + Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template. + false + 4.14.0.0 + string + + + clusterid + destination Cluster ID to deploy the VM to - parameter available for root admin only + false + 4.13 + uuid + + + copyimagetags + if true the image tags (if any) will be copied to the VM, default value is false + false + 4.13 + boolean + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter + false + map + 4.11 + map + + + deploymentplanner + Deployment planner to use for vm allocation. Available to ROOT admin only + false + 4.4 + string + + + details + used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details + false + map + 4.3 + map + + + dhcpoptionsnetworklist + DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com + false + map + map + + + diskofferingid + the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created. + false + uuid + + + displayname + an optional user generated name for the virtual machine + false + string + + + displayvm + an optional field, whether to the display the vm to the end user or not. + false + 4.2 + boolean + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain. + false + uuid + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable + false + 4.16 + boolean + + + extraconfig + an optional URL encoded string that can be passed to the virtual machine upon successful deployment + false + 4.12 + string + + + group + an optional group for the virtual machine + false + string + + + hostid + destination Host ID to deploy the VM to - parameter available for root admin only + false + uuid + + + hypervisor + the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call + false + string + + + iodriverpolicy + Controls specific policies on IO + false + string + + + iothreadsenabled + IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs. + false + boolean + + + ip6address + the ipv6 address for default vm's network + false + string + + + ipaddress + the ip address for default vm's network + false + string + + + iptonetworklist + ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid + false + map + map + + + keyboard + an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us + false + string + + + keypair + name of the ssh key pair used to login to the virtual machine + false + string + + + keypairs + names of the ssh key pairs used to login to the virtual machine + false + list + 4.17 + list + + + macaddress + the mac address for default vm's network + false + string + + + name + host name for the virtual machine + false + string + + + networkids + list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter + false + list + list + + + nicmultiqueuenumber + The number of queues for multiqueue NICs. + false + 4.18 + integer + + + nicnetworklist + VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid + false + map + 4.15 + map + + + nicpackedvirtqueuesenabled + Enable packed virtqueues or not. + false + 4.18 + boolean + + + overridediskofferingid + the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id + false + 4.17 + uuid + + + password + The password of the virtual machine. If null, a random password will be generated for the VM. + false + 4.19.0.0 + string + + + podid + destination Pod ID to deploy the VM to - parameter available for root admin only + false + 4.13 + uuid + + + projectid + Deploy vm for the project + false + uuid + + + properties + used to specify the vApp properties. + false + map + 4.15 + map + + + rootdisksize + Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided + false + 4.4 + long + + + securitygroupids + comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + securitygroupnames + comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + size + the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId + false + long + + + startvm + true if start vm after creating; defaulted to true if not specified + false + boolean + + + userdata + an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value + false + string + + + userdatadetails + used to specify the parameters values for the variables in userdata. + false + map + 4.18 + map + + + userdataid + the ID of the Userdata + false + 4.18 + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVolumes + Lists all volumes. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster id the disk volume belongs to + false + uuid + + + diskofferingid + list volumes by disk offering + false + 4.4 + uuid + + + displayvolume + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hostid + list volumes on specified host + false + uuid + + + id + the ID of the disk volume + false + uuid + + + ids + the IDs of the volumes, mutually exclusive with id + false + list + 4.9 + list + + + isencrypted + list only volumes that are encrypted + false + 4.19.1 + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + listsystemvms + list system VMs; only ROOT admin is eligible to pass this parameter + false + 4.18 + boolean + + + name + the name of the disk volume + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the pod id the disk volume belongs to + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + serviceofferingid + list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored + false + 4.19.1 + uuid + + + state + state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged. + false + string + + + storageid + the ID of the storage pool, available to ROOT admin only + false + 4.3 + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + type + the type of disk volume + false + string + + + virtualmachineid + the ID of the virtual machine + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createLBHealthCheckPolicy + Creates a load balancer health check policy + true + 4.2.0 + + + lbruleid + the ID of the load balancer rule + true + uuid + + + description + the description of the load balancer health check policy + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + healthythreshold + Number of consecutive health check success before declaring an instance healthy + false + integer + + + intervaltime + Amount of time between health checks (1 sec - 20940 sec) + false + integer + + + pingpath + HTTP ping path + false + string + + + responsetimeout + Time to wait when receiving a response from the health check (2sec - 60 sec) + false + integer + + + unhealthythreshold + Number of consecutive health check failures before declaring an instance unhealthy + false + integer + + + + + account + the account of the HealthCheck policy + string + + + domain + the domain of the HealthCheck policy + string + + + domainid + the domain ID of the HealthCheck policy + string + + + lbruleid + the LB rule ID + string + + + zoneid + the id of the zone the HealthCheck policy belongs to + string + + + healthcheckpolicy(*) + the list of healthcheckpolicies + + + id + the LB HealthCheck policy ID + string + + + description + the description of the healthcheck policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + healthcheckinterval + Amount of time between health checks + int + + + healthcheckthresshold + Number of consecutive health check success before declaring an instance healthy + int + + + pingpath + the pingpath of the healthcheck policy + string + + + responsetime + Time to wait when receiving a response from the health check + int + + + state + the state of the policy + string + + + unhealthcheckthresshold + Number of consecutive health check failures before declaring an instance unhealthy. + int + + + list + + + false + + + changeSharedFileSystemServiceOffering + Change Service offering of a Shared FileSystem + true + 4.20.0 + + + id + the ID of the shared filesystem + true + uuid + + + serviceofferingid + the offering to use for the shared filesystem instance + true + uuid + + + + + id + ID of the shared filesystem + string + + + account + the account associated with the shared filesystem + string + + + description + description of the shared filesystem + string + + + diskioread + the read (IO) of disk on the shared filesystem + long + + + diskiowrite + the write (IO) of disk on the shared filesystem + long + + + diskkbsread + the shared filesystem's disk read in KiB + long + + + diskkbswrite + the shared filesystem's disk write in KiB + long + + + diskofferingdisplaytext + disk offering display text for the shared filesystem + string + + + diskofferingid + disk offering ID for the shared filesystem + string + + + diskofferingname + disk offering for the shared filesystem + string + + + domain + the domain associated with the shared filesystem + string + + + domainid + the ID of the domain associated with the shared filesystem + string + + + domainpath + path of the domain to which the shared filesystem + string + + + filesystem + the filesystem format + string + + + iscustomdiskoffering + disk offering for the shared filesystem has custom size + boolean + + + name + name of the shared filesystem + string + + + networkid + Network ID of the shared filesystem + string + + + networkname + Network name of the shared filesystem + string + + + path + path to mount the shared filesystem + string + + + physicalsize + the bytes actually consumed on disk + long + + + project + the project name of the shared filesystem + string + + + projectid + the project ID of the shared filesystem + string + + + provider + the shared filesystem provider + string + + + provisioningtype + provisioning type used in the shared filesystem + string + + + serviceofferingid + service offering ID for the shared filesystem + string + + + serviceofferingname + service offering for the shared filesystem + string + + + size + size of the shared filesystem + long + + + sizegb + size of the shared filesystem in GiB + string + + + state + the state of the shared filesystem + string + + + storage + name of the storage pool hosting the data volume + string + + + storageid + ID of the storage pool hosting the data volume + string + + + utilization + the disk utilization + string + + + virtualmachineid + ID of the storage fs vm + string + + + virtualsize + the bytes allocated + long + + + vmstate + ID of the storage fs vm + string + + + volumeid + ID of the storage fs data volume + string + + + volumename + name of the storage fs data volume + string + + + zoneid + ID of the availability zone + string + + + zonename + Name of the availability zone + string + + + nic(*) + the list of nics associated with the shared filesystem + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + list + + + false + + + lockUser + Locks a user account + false + + + id + Locks user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + cloudianIsEnabled + Checks if the Cloudian Connector is enabled + false + 4.11.0 + + + + enabled + the Cloudian connector enabled state + boolean + + + url + the Cloudian Management Console base URL + string + + + false + + + createNetwork + Creates a network + false + + + name + the name of the network + true + string + + + networkofferingid + the network offering ID + true + uuid + + + zoneid + the zone ID for the network + true + uuid + + + account + Account that will own the network. Account should be under the selected domain + false + string + + + aclid + Network ACL ID associated for the network + false + uuid + + + acltype + Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network + false + string + + + asnumber + the AS Number of the network + false + 4.20.0 + long + + + associatednetworkid + The network this network is associated to. only available if create a Shared network + false + 4.17.0 + uuid + + + bgppeerids + Ids of the Bgp Peer for the network + false + list + 4.20.0 + list + + + bypassvlanoverlapcheck + when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks + false + boolean + + + cidrsize + the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode. + false + 4.20.0 + integer + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + false + boolean + + + displaytext + the display text of the network + false + string + + + dns1 + the first IPv4 DNS for the network + false + 4.18.0 + string + + + dns2 + the second IPv4 DNS for the network + false + 4.18.0 + string + + + domainid + domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain. + false + uuid + + + endip + the ending IP address in the network IP range. If not specified, will be defaulted to startIP + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + externalid + ID of the network in an external system. + false + string + + + gateway + the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC + false + string + + + hideipaddressusage + when true ip address usage for the network will not be exported by the listUsageRecords API + false + boolean + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6dns1 + the first IPv6 DNS for the network + false + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + false + 4.18.0 + string + + + ip6gateway + the gateway of the IPv6 network. Required for Shared networks + false + string + + + isolatedpvlan + the isolated private VLAN for this network + false + string + + + isolatedpvlantype + the isolated private VLAN type for this network + false + string + + + netmask + the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC + false + string + + + networkdomain + network domain + false + string + + + physicalnetworkid + the physical network ID the network belongs to + false + uuid + + + privatemtu + MTU to be configured on the network VR's private interface(s) + false + 4.18.0 + integer + + + projectid + an optional project for the network + false + uuid + + + publicmtu + MTU to be configured on the network VR's public facing interfaces + false + 4.18.0 + integer + + + routerip + IPV4 address to be assigned to a router in a shared network + false + 4.16 + string + + + routeripv6 + IPV6 address to be assigned to a router in a shared network + false + 4.16 + string + + + sourcenatipaddress + IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. +If an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented, + false + 4.19 + string + + + startip + the beginning IP address in the network IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + subdomainaccess + Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified + false + boolean + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + false + string + + + vlan + the ID or VID of the network + false + string + + + vpcid + the VPC network belongs to + false + uuid + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + asnumber + AS NUMBER + 4.20.0 + long + + + asnumberid + UUID of AS NUMBER + 4.20.0 + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + bgppeers + The BGP peers for the network + 4.20.0 + set + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip4routes + The routes for the network to ease adding route in upstream router + 4.20.0 + set + + + ip4routing + The IPv4 routing type of network + 4.20.0 + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The Ipv6 routing type of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listNetworkOfferings + Lists all available network offerings. + false + + + availability + the availability of network offering. Default value is required + false + string + + + displaytext + list network offerings by display text + false + string + + + domainid + list network offerings available for network creation in specific domain + false + 4.13 + uuid + + + forvpc + the network offering can be used only for network creation inside the VPC + false + boolean + + + guestiptype + list network offerings by guest type: shared or isolated + false + string + + + id + list network offerings by ID + false + uuid + + + isdefault + true if need to list only default network offerings. Default value is false + false + boolean + + + istagged + true if offering has tags specified + false + boolean + + + keyword + List by keyword + false + string + + + name + list network offerings by name + false + string + + + networkid + the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to. + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + routingmode + the routing mode for the network offering. Supported types are: Static or Dynamic. + false + 4.20.0 + string + + + sourcenatsupported + true if need to list only netwok offerings where source NAT is supported, false otherwise + false + boolean + + + specifyipranges + true if need to list only network offerings which support specifying ip ranges + false + boolean + + + specifyvlan + the tags for the network offering. + false + boolean + + + state + list network offerings by state + false + string + + + supportedservices + list network offerings supporting certain services + false + list + list + + + tags + list network offerings by tags + false + string + + + traffictype + list by traffic type + false + string + + + zoneid + list network offerings available for network creation in specific zone + false + uuid + + + + + id + the id of the network offering + string + + + availability + availability of the network offering + string + + + conservemode + true if network offering is ip conserve mode enabled + boolean + + + created + the date this network offering was created + date + + + details + additional key/value details tied with network offering + 4.2.0 + map + + + displaytext + an alternate display text of the network offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + fornsx + true if network offering can be used by NSX networks only + boolean + + + fortungsten + true if network offering can be used by Tungsten-Fabric networks only + boolean + + + forvpc + true if network offering can be used by VPC networks only + boolean + + + guestiptype + guest type of the network offering, can be Shared or Isolated + string + + + internetprotocol + the internet protocol of the network offering + string + + + isdefault + true if network offering is default, false otherwise + boolean + + + ispersistent + true if network offering supports persistent networks, false otherwise + boolean + + + maxconnections + maximum number of concurrents connections to be handled by lb + integer + + + name + the name of the network offering + string + + + networkmode + Mode in which the network will operate. The valid values are NATTED and ROUTED + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + routingmode + the routing mode for the network offering, supported types are Static or Dynamic. + string + + + serviceofferingid + the ID of the service offering used by virtual router provider + string + + + specifyasnumber + true if network offering supports choosing AS numbers + boolean + + + specifyipranges + true if network offering supports specifying ip ranges, false otherwise + boolean + + + specifyvlan + true if network offering supports vlans, false otherwise + boolean + + + state + state of the network offering. Can be Disabled/Enabled/Inactive + string + + + supportsinternallb + true if network offering supports public access for guest networks + 4.20.0 + boolean + + + supportspublicaccess + true if network offering supports public access for guest networks + 4.10.0 + boolean + + + supportsstrechedl2subnet + true if network offering supports network that span multiple zones + 4.4 + boolean + + + tags + the tags for the network offering + string + + + traffictype + the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage. + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + listDedicatedPods + Lists dedicated pods. + false + + + account + the name of the account associated with the pod. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated pods by affinity group + false + uuid + + + domainid + the ID of the domain associated with the pod + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + the ID of the pod + false + uuid + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account Id to which the Pod is dedicated + string + + + affinitygroupid + the Dedication Affinity Group ID of the pod + string + + + domainid + the domain ID to which the Pod is dedicated + string + + + podid + the ID of the Pod + string + + + podname + the Name of the Pod + string + + + false + + + listVPCs + Lists VPCs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + cidr + list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR + false + string + + + displaytext + List by display text of the VPC + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + list VPC by id + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list by name of the VPC + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + restartrequired + list VPCs by restartRequired option + false + boolean + + + showicon + flag to display the resource icon for VPCs + false + boolean + + + state + list VPCs by state + false + string + + + supportedservices + list VPC supporting certain services + false + list + list + + + tags + List resources by tags (key/value pairs) + false + map + map + + + vpcofferingid + list by ID of the VPC offering + false + uuid + + + zoneid + list by zone + false + uuid + + + + + id + the id of the VPC + string + + + account + the owner of the VPC + string + + + asnumber + AS NUMBER + 4.20.0 + long + + + asnumberid + UUID of AS NUMBER + 4.20.0 + string + + + bgppeers + The BGP peers for the VPC + 4.20.0 + set + + + cidr + the cidr the VPC + string + + + created + the date this VPC was created + date + + + displaytext + an alternate display text of the VPC. + string + + + distributedvpcrouter + is VPC uses distributed router for one hop forwarding and host based network ACL's + 4.4 + boolean + + + dns1 + the first IPv4 DNS for the VPC + string + + + dns2 + the second IPv4 DNS for the VPC + string + + + domain + the domain name of the owner + string + + + domainid + the domain id of the VPC owner + string + + + domainpath + the domain path of the owner + 4.19.2.0 + string + + + fordisplay + is vpc for display to the regular user + 4.4 + boolean + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ip4routes + The routes for the VPC to ease adding route in upstream router + 4.20.0 + set + + + ip4routing + The IPv4 routing mode of VPC + 4.20.0 + string + + + ip6dns1 + the first IPv6 DNS for the VPC + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the VPC + 4.18.0 + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + name + the name of the VPC + string + + + network + the list of networks belongign to the VPC + list + + + networkdomain + the network domain of the VPC + string + + + project + the project name of the VPC + string + + + projectid + the project id of the VPC + string + + + publicmtu + MTU configured on the public interfaces of the VPC VR + 4.18.0 + integer + + + redundantvpcrouter + if this VPC has redundant router + 4.6 + boolean + + + regionlevelvpc + true if VPC is region level + 4.4 + boolean + + + restartrequired + true VPC requires restart + boolean + + + state + state of the VPC. Can be Inactive/Enabled + string + + + vpcofferingid + vpc offering id the VPC is created from + string + + + vpcofferingname + vpc offering name the VPC is created from + 4.13.2 + string + + + zoneid + zone id of the vpc + string + + + zonename + the name of the zone the VPC belongs to + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with the project + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + addNetworkDevice + Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer + false + + + networkdeviceparameterlist + parameters for network device + false + map + map + + + networkdevicetype + Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall + false + string + + + + + id + the ID of the network device + string + + + false + + + runDiagnostics + Execute network-utility command (ping/arping/tracert) on system VMs remotely + true + 4.12.0.0 + + + ipaddress + The IP/Domain address to test connection to + true + string + + + targetid + The ID of the system VM instance to diagnose + true + uuid + + + type + The system VM diagnostics type valid options are: ping, traceroute, arping + true + string + + + params + Additional command line options that apply for each command + false + string + + + + + exitcode + the command execution return code + string + + + stderr + the standard error output from the command execution + string + + + stdout + the standard output from the command execution + string + + + false + + + restartVPC + Restarts a VPC + true + + + id + the id of the VPC + true + uuid + + + cleanup + If cleanup old network elements + false + boolean + + + livepatch + Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false. + false + 4.17.0 + boolean + + + makeredundant + Turn a single VPC into a redundant one. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaConfigureEmail + Configure a quota email template + false + 4.20.0.0 + + + accountid + Account ID for which to configure quota template email or min balance + true + uuid + + + enable + If the quota email template should be enabled + false + boolean + + + minbalance + New quota account min balance + false + double + + + templatename + Quota email template name which should be configured + false + string + + + + + account + The configured account's id. + string + + + enabled + Whether the template is enabled. + boolean + + + minbalance + The configured account's min balance. + double + + + templatename + The template's name. + string + + + false + + + addBaremetalDhcp + adds a baremetal dhcp server + true + + + dhcpservertype + Type of dhcp device + true + string + + + password + Credentials to reach external dhcp device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the external dhcp appliance. + true + string + + + username + Credentials to reach external dhcp device + true + string + + + + + id + device id of + string + + + dhcpservertype + name of the provider + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + deleteTungstenFabricApplicationPolicySet + delete Tungsten-Fabric application policy set + true + + + applicationpolicysetuuid + the uuid of Tungsten-Fabric application policy set + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + copySnapshot + Copies a snapshot from one zone to another. + true + 4.19.0 + + + id + the ID of the snapshot. + true + uuid + + + destzoneid + The ID of the zone the snapshot is being copied to. + false + uuid + + + destzoneids + A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required. + false + list + list + + + sourcezoneid + The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used. + false + uuid + + + + + id + ID of the snapshot + string + + + account + the account associated with the snapshot + string + + + created + the date the snapshot was created + date + + + datastoreid + ID of the datastore for the snapshot entry + 4.19.0 + string + + + datastorename + name of the datastore for the snapshot entry + 4.19.0 + string + + + datastorestate + state of the snapshot on the datastore + 4.19.0 + string + + + datastoretype + type of the datastore for the snapshot entry + 4.19.0 + string + + + domain + the domain name of the snapshot's account + string + + + domainid + the domain ID of the snapshot's account + string + + + domainpath + path of the Domain the snapshot's account belongs to + 4.19.2.0 + string + + + downloaddetails + download progress of a snapshot + 4.19.0 + map + + + intervaltype + valid types are hourly, daily, weekly, monthy, template, and none. + string + + + locationtype + valid location types are primary and secondary. + string + + + name + name of the snapshot + string + + + osdisplayname + display name of the os on volume + string + + + ostypeid + id of the os on volume + 4.10 + string + + + physicalsize + physical size of backedup snapshot on image store + long + + + project + the project name of the snapshot + string + + + projectid + the project id of the snapshot + string + + + revertable + indicates whether the underlying storage supports reverting the volume to this snapshot + boolean + + + snapshottype + the type of the snapshot + string + + + state + the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage + state + + + status + the status of the template + string + + + virtualsize + virtual size of backedup snapshot on image store + long + + + volumeid + ID of the disk volume + string + + + volumename + name of the disk volume + string + + + volumestate + state of the disk volume + string + + + volumetype + type of the disk volume + string + + + zoneid + id of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addTrafficMonitor + Adds Traffic Monitor Host for Direct Network Usage + false + + + url + URL of the traffic monitor Host + true + string + + + zoneid + Zone in which to add the external firewall appliance. + true + uuid + + + excludezones + Traffic going into the listed zones will not be metered + false + string + + + includezones + Traffic going into the listed zones will be metered + false + string + + + + + id + the ID of the external firewall + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + listUsers + Lists user accounts + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accounttype + List users by account type. Valid types include admin, domain-admin, read-only-admin, or user. + false + integer + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + List user by ID. + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + showicon + flag to display the resource icon for users + false + boolean + + + state + List users by state of the user account. + false + string + + + username + List user by the username + false + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + updateVlanIpRange + Updates a VLAN IP range. + false + 4.16.0 + + + id + the UUID of the VLAN IP range + true + uuid + + + endip + the ending IP address in the VLAN IP range + false + string + + + endipv6 + the ending IPv6 address in the IPv6 network range + false + string + + + forsystemvms + true if IP range is set to system vms, false if not + false + boolean + + + gateway + the gateway of the VLAN IP range + false + string + + + ip6cidr + the CIDR of IPv6 network, must be at least /64 + false + string + + + ip6gateway + the gateway of the IPv6 network + false + string + + + netmask + the netmask of the VLAN IP range + false + string + + + startip + the beginning IP address in the VLAN IP range + false + string + + + startipv6 + the beginning IPv6 address in the IPv6 network range + false + string + + + + + id + the ID of the VLAN IP range + string + + + account + the account of the VLAN IP range + string + + + cidr + the cidr of the VLAN IP range + string + + + description + the description of the VLAN IP range + string + + + domain + the domain name of the VLAN IP range + string + + + domainid + the domain ID of the VLAN IP range + string + + + domainpath + path of the domain to which the VLAN IP range belongs + 4.19.2.0 + string + + + endip + the end ip of the VLAN IP range + string + + + endipv6 + the end ipv6 of the VLAN IP range + string + + + fornsx + indicates whether IP range is dedicated to NSX resources or not + boolean + + + forsystemvms + indicates whether VLAN IP range is dedicated to system vms or not + boolean + + + forvirtualnetwork + the virtual network for the VLAN IP range + boolean + + + gateway + the gateway of the VLAN IP range + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + netmask + the netmask of the VLAN IP range + string + + + networkid + the network id of vlan range + string + + + physicalnetworkid + the physical network this belongs to + string + + + podid + the Pod ID for the VLAN IP range + string + + + podname + the Pod name for the VLAN IP range + string + + + project + the project name of the vlan range + string + + + projectid + the project id of the vlan range + string + + + startip + the start ip of the VLAN IP range + string + + + startipv6 + the start ipv6 of the VLAN IP range + string + + + vlan + the ID or VID of the VLAN. + string + + + zoneid + the Zone ID of the VLAN IP range + string + + + false + + + listResourceLimits + Lists resource limits. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + Lists resource limits by ID. + false + long + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + resourcetype + Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + integer + + + resourcetypename + Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + string + + + tag + Tag for the resource type + false + 4.20.0 + string + + + + + account + the account of the resource limit + string + + + domain + the domain name of the resource limit + string + + + domainid + the domain ID of the resource limit + string + + + domainpath + path of the domain to which the resource limit belongs + 4.19.2.0 + string + + + max + the maximum number of the resource. A -1 means the resource currently has no limit. + long + + + project + the project name of the resource limit + string + + + projectid + the project id of the resource limit + string + + + resourcetype + 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. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + tag + The tag for the resource limit + 4.20.0 + string + + + false + + + disableUser + Disables a user account + true + + + id + Disables user by user ID. + true + uuid + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + listIsos + Lists all available ISO files. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + arch + the CPU arch of the ISO. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + bootable + true if the ISO is bootable, false otherwise + false + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + hypervisor + the hypervisor for which to restrict the search + false + string + + + id + list ISO by ID + false + uuid + + + imagestoreid + ID of the image or image cache store + false + 4.19 + uuid + + + isofilter + possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). + false + string + + + ispublic + true if the ISO is publicly available to all users, false otherwise. + false + boolean + + + isready + true if this ISO is ready to be deployed + false + boolean + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + list all ISOs by name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + showicon + flag to display the resource image for the isos + false + boolean + + + showremoved + show removed ISOs as well + false + boolean + + + showunique + If set to true, list only unique isos across zones + false + 4.13.2 + boolean + + + storageid + ID of the storage pool + false + 4.19 + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + zoneid + the ID of the zone + false + uuid + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listAutoScalePolicies + Lists autoscale policies. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + false + string + + + conditionid + the ID of the condition of the policy + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the autoscale policy + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the autoscale policy + false + 4.18.0 + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + vmgroupid + the ID of the autoscale vm group + false + uuid + + + + + id + the autoscale policy ID + string + + + account + the account owning the autoscale policy + string + + + action + the action to be executed if all the conditions evaluate to true for the specified duration. + string + + + conditions + the list of IDs of the conditions that are being evaluated on every interval + list + + + domain + the domain name of the autoscale policy + string + + + domainid + the domain ID of the autoscale policy + string + + + domainpath + path of the domain to which the autoscale policy belongs + 4.19.2.0 + string + + + duration + the duration for which the conditions have to be true before action is taken + integer + + + name + name of the autoscale policy + string + + + project + the project name of the autoscale policy + string + + + projectid + the project id autoscale policy + string + + + quiettime + the cool down period for which the policy should not be evaluated after the action has been taken + integer + + + false + + + dedicateIpv4SubnetForZone + Dedicates an existing IPv4 subnet for a zone to an account or a domain. + true + 4.20.0 + + + id + Id of the guest network IPv4 subnet + true + uuid + + + account + account who will own the IPv4 subnet + false + string + + + domainid + domain ID of the account owning the IPv4 subnet + false + uuid + + + projectid + project who will own the IPv4 subnet + false + uuid + + + + + id + id of the guest IPv4 subnet + string + + + account + the account of the IPv4 subnet + string + + + created + date when this IPv4 subnet was created. + date + + + domain + the domain name of the IPv4 subnet + string + + + domainid + the domain ID of the IPv4 subnet + string + + + project + the project name of the IPv4 subnet + string + + + projectid + the project id of the IPv4 subnet + string + + + subnet + guest IPv4 subnet + string + + + zoneid + id of zone to which the IPv4 subnet belongs to. + string + + + zonename + name of zone to which the IPv4 subnet belongs to. + string + + + false + + + listSharedFileSystems + List Shared FileSystems + false + 4.20.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + diskofferingid + the disk offering of the shared filesystem + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + id + the ID of the shared filesystem + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the shared filesystem + false + string + + + networkid + the ID of the network + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + serviceofferingid + the service offering of the shared filesystem + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + zoneid + the ID of the availability zone + false + uuid + + + + + id + ID of the shared filesystem + string + + + account + the account associated with the shared filesystem + string + + + description + description of the shared filesystem + string + + + diskioread + the read (IO) of disk on the shared filesystem + long + + + diskiowrite + the write (IO) of disk on the shared filesystem + long + + + diskkbsread + the shared filesystem's disk read in KiB + long + + + diskkbswrite + the shared filesystem's disk write in KiB + long + + + diskofferingdisplaytext + disk offering display text for the shared filesystem + string + + + diskofferingid + disk offering ID for the shared filesystem + string + + + diskofferingname + disk offering for the shared filesystem + string + + + domain + the domain associated with the shared filesystem + string + + + domainid + the ID of the domain associated with the shared filesystem + string + + + domainpath + path of the domain to which the shared filesystem + string + + + filesystem + the filesystem format + string + + + iscustomdiskoffering + disk offering for the shared filesystem has custom size + boolean + + + name + name of the shared filesystem + string + + + networkid + Network ID of the shared filesystem + string + + + networkname + Network name of the shared filesystem + string + + + path + path to mount the shared filesystem + string + + + physicalsize + the bytes actually consumed on disk + long + + + project + the project name of the shared filesystem + string + + + projectid + the project ID of the shared filesystem + string + + + provider + the shared filesystem provider + string + + + provisioningtype + provisioning type used in the shared filesystem + string + + + serviceofferingid + service offering ID for the shared filesystem + string + + + serviceofferingname + service offering for the shared filesystem + string + + + size + size of the shared filesystem + long + + + sizegb + size of the shared filesystem in GiB + string + + + state + the state of the shared filesystem + string + + + storage + name of the storage pool hosting the data volume + string + + + storageid + ID of the storage pool hosting the data volume + string + + + utilization + the disk utilization + string + + + virtualmachineid + ID of the storage fs vm + string + + + virtualsize + the bytes allocated + long + + + vmstate + ID of the storage fs vm + string + + + volumeid + ID of the storage fs data volume + string + + + volumename + name of the storage fs data volume + string + + + zoneid + ID of the availability zone + string + + + zonename + Name of the availability zone + string + + + nic(*) + the list of nics associated with the shared filesystem + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + list + + + false + + + addBaremetalRct + adds baremetal rack configuration text + true + + + baremetalrcturl + http url to baremetal RCT configuration + true + object + + + + + id + id of rct + string + + + url + url + string + + + false + + + updateRole + Updates a role + false + 4.9.0 + + + id + ID of the role + true + uuid + + + description + The description of the role + false + string + + + description + The description of the role + false + string + + + ispublic + Indicates whether the role will be visible to all users (public) or only to root admins (private). + false + boolean + + + name + creates a role with this unique name + false + string + + + type + The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + state + the state of the role + string + + + type + the type of the role + string + + + false + + + listRemoteAccessVpns + Lists remote access vpns + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + Lists remote access vpn rule with the specified ID + false + 4.3 + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + networkid + list remote access VPNs for certain network + false + 4.3 + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + publicipid + public ip address id of the vpn server + false + uuid + + + + + id + the id of the remote access vpn + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + fordisplay + is vpn for display to the regular user + 4.4 + boolean + + + iprange + the range of ips to allocate to the clients + string + + + presharedkey + the ipsec preshared key + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + publicip + the public ip address of the vpn server + string + + + publicipid + the public ip address of the vpn server + string + + + state + the state of the rule + string + + + false + + + deleteWebhook + Deletes a Webhook + false + 4.20.0 + + + id + The ID of the Webhook + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetworkACLList + Deletes a network ACL + true + + + id + the ID of the network ACL + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + removeIpFromNic + Removes secondary IP from the NIC. + true + + + id + the ID of the secondary ip address to nic + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createServiceInstance + Creates a system virtual-machine that implements network services + true + + + leftnetworkid + The left (inside) network for service instance + true + uuid + + + name + The name of the service instance + true + string + + + rightnetworkid + The right (outside) network ID for the service instance + true + uuid + + + serviceofferingid + The service offering ID that defines the resources consumed by the service appliance + true + uuid + + + templateid + The template ID that specifies the image for the service appliance + true + uuid + + + zoneid + Availability zone for the service instance + true + uuid + + + account + An optional account for the virtual machine. Must be used with domainId. + false + string + + + domainid + An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + Project ID for the service instance + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the Domain in which the virtual machine exists + 4.19.2.0 + string + + + name + the name of the virtual machine + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + false + + + startSystemVm + Starts a system virtual machine. + true + + + id + The ID of the system virtual machine + true + uuid + + + + + id + the ID of the system VM + string + + + activeviewersessions + the number of active console sessions for the console proxy system vm + integer + + + agentstate + the agent state of the system VM + 4.13.1 + string + + + created + the date and time the system VM was created + date + + + disconnected + the last disconnected date of host + 4.13.1 + date + + + dns1 + the first DNS for the system VM + string + + + dns2 + the second DNS for the system VM + string + + + gateway + the gateway for the system VM + string + + + guestvlan + guest vlan range + string + + + hostcontrolstate + the control state of the host for the system VM + string + + + hostid + the host ID for the system VM + string + + + hostname + the hostname for the system VM + string + + + hypervisor + the hypervisor on which the template runs + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + jobid + the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + string + + + jobstatus + the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. + integer + + + linklocalip + the link local IP address for the system vm + string + + + linklocalmacaddress + the link local MAC address for the system vm + string + + + linklocalnetmask + the link local netmask for the system vm + string + + + name + the name of the system VM + string + + + networkdomain + the network domain for the system VM + string + + + podid + the Pod ID for the system VM + string + + + podname + the Pod name for the system VM + 4.13.2 + string + + + privateip + the private IP address for the system VM + string + + + privatemacaddress + the private MAC address for the system VM + string + + + privatenetmask + the private netmask for the system VM + string + + + publicip + the public IP address for the system VM + string + + + publicmacaddress + the public MAC address for the system VM + string + + + publicnetmask + the public netmask for the system VM + string + + + publicvlan + public vlan range + list + + + serviceofferingid + the ID of the service offering of the system virtual machine. + string + + + serviceofferingname + the name of the service offering of the system virtual machine. + string + + + state + the state of the system VM + string + + + systemvmtype + the system VM type + string + + + templateid + the template ID for the system VM + string + + + templatename + the template name for the system VM + 4.13.2 + string + + + version + the systemvm agent version + 4.13.1 + string + + + zoneid + the Zone ID for the system VM + string + + + zonename + the Zone name for the system VM + string + + + false + + + registerVnfTemplate + Registers an existing VNF template into the CloudStack cloud. + false + 4.19.0 + + + format + the format for the template. Possible values include QCOW2, RAW, VHD and OVA. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the template + true + string + + + url + the URL of where the template is hosted. Possible URL include http:// and https:// + true + string + + + account + an optional accountName. Must be used with domainId. + false + string + + + arch + the CPU arch of the template. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + directdownload + true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + displaytext + The display text of the template, defaults to 'name'. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Register template for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + 4.19.0 + string + + + vnfdetails + VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0 + false + map + map + + + vnfnics + VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC + false + map + map + + + zoneid + the ID of the zone the template is to be hosted on + false + uuid + + + zoneids + A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. + false + list + list + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVirtualMachinesUsageHistory + Lists VM stats + false + 4.17 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the virtual machine. + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + name + the name of the virtual machine + string + + + stats + the list of VM stats + list + + + false + + + createKubernetesCluster + Creates a Kubernetes cluster + true + + + name + name for the Kubernetes cluster + true + string + + + zoneid + availability zone in which Kubernetes cluster to be launched + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged. + false + 4.19.0 + string + + + controlnodes + number of Kubernetes cluster control nodes, default is 1 + false + long + + + description + description for the Kubernetes cluster + false + string + + + dockerregistrypassword + password for the docker image private registry + false + string + + + dockerregistryurl + URL for the docker image private registry + false + string + + + dockerregistryusername + user name for the docker image private registry + false + string + + + domainid + an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. + false + uuid + + + externalloadbalanceripaddress + external load balancer IP address while using shared network with Kubernetes HA cluster + false + string + + + keypair + name of the ssh key pair used to login to the virtual machines + false + string + + + kubernetesversionid + Kubernetes version with which cluster to be launched + false + uuid + + + masternodes + number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter. + false + long + + + networkid + Network in which Kubernetes cluster is to be launched + false + uuid + + + noderootdisksize + root disk size in GB for each node + false + long + + + projectid + Deploy cluster for the project + false + uuid + + + serviceofferingid + the ID of the service offering for the virtual machines in the cluster. + false + uuid + + + size + number of Kubernetes cluster worker nodes + false + long + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + declareHostAsDegraded + Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host. + true + 4.16.0.0 + + + id + host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + arch + CPU Arch of the host + 4.20 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + explicithosttags + comma-separated list of explicit host tags for the host + 4.20.0 + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + implicithosttags + comma-separated list of implicit host tags for the host + 4.20.0 + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listStorageNetworkIpRange + List a storage network IP range. + false + 3.0.0 + + + id + optional parameter. Storaget network IP range uuid, if specicied, using it to search the range. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range. + false + uuid + + + zoneid + optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range. + false + uuid + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + configureVirtualRouterElement + Configures a virtual router element. + true + + + id + the ID of the virtual router provider + true + uuid + + + enabled + Enabled/Disabled the service provider + true + boolean + + + + + id + the id of the router + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + enableHAForHost + Enables HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + registerNetscalerServicePackage + Registers NCC Service Package + false + + + description + Description of Service Package + true + string + + + name + Name of the service Package. + true + string + + + + + id + Service Package UUID + string + + + description + Description of Service Package + string + + + name + Service Package Name + string + + + false + + + updateVMAffinityGroup + Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. + true + + + id + The ID of the virtual machine + true + uuid + + + affinitygroupids + comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter + false + list + list + + + affinitygroupnames + comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter + false + list + list + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateWebhook + Updates a Webhook + false + 4.20.0 + + + id + The ID of the Webhook + true + uuid + + + description + Description for the Webhook + false + string + + + name + Name for the Webhook + false + string + + + payloadurl + Payload URL of the Webhook + false + string + + + scope + Scope of the Webhook + false + string + + + secretkey + Secret key of the Webhook + false + string + + + sslverification + If set to true then SSL verification will be done for the Webhook otherwise not + false + boolean + + + state + State of the Webhook + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + quotaCredits + Add +-credits to an account + false + 4.7.0 + + + account + Account Id for which quota credits need to be added + true + string + + + domainid + Domain for which quota credits need to be added + true + uuid + + + value + Value of the credits to be added+, subtracted- + true + double + + + min_balance + Minimum balance threshold of the account + false + double + + + quota_enforce + Account for which quota enforce is set to false will not be locked when there is no credit balance + false + boolean + + + + + credits + the credit deposited + bigdecimal + + + currency + currency + string + + + updated_by + the user name of the admin who updated the credits + string + + + updated_on + the account name of the admin who updated the credits + date + + + false + + + listCaCertificate + Lists the CA public certificate(s) as support by the configured/provided CA plugin + false + 4.11.0 + + + provider + Name of the CA service provider, otherwise the default configured provider plugin will be used + false + string + + + + + cacertificates + The CA certificate(s) + string + + + certificate + The client certificate + string + + + privatekey + Private key for the certificate + string + + + false + + + provisionTemplateDirectDownloadCertificate + Provisions a host with a direct download certificate + false + 4.17.0 + + + id + the id of the direct download certificate to provision + true + uuid + + + hostid + the host to provision the certificate + true + uuid + + + + + details + indicates the details in case of failure or host skipped + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + status + indicates if the certificate has been revoked from the host, failed or skipped + string + + + false + + + samlSlo + SAML Global Log Out API + false + + + + description + Response description + string + + + false + + + updateProjectRole + Creates a Project role + false + 4.15.0 + + + id + ID of the Project role + true + uuid + + + projectid + ID of project where role is being created + true + uuid + + + description + The description of the Project role + false + string + + + name + creates a project role with this unique name + false + string + + + + + projectid + the id of the project + string + + + false + + + addLdapConfiguration + Add a new Ldap Configuration + false + 4.2.0 + + + hostname + Hostname + true + string + + + port + Port + true + integer + + + domainid + linked domain + false + uuid + + + + + domainid + linked domain + string + + + hostname + name of the host running the ldap server + string + + + port + port the ldap server is running on + int + + + false + + + createTungstenFabricAddressGroup + create Tungsten-Fabric address group + true + + + ipprefix + Tungsten-Fabric ip prefix + true + string + + + ipprefixlen + Tungsten-Fabric ip prefix length + true + integer + + + name + Tungsten-Fabric address group name + true + string + + + zoneid + the ID of zone + true + uuid + + + + + ipprefix + Tungsten-Fabric address group ip prefix + string + + + ipprefixlen + Tungsten-Fabric address group ip prefix length + int + + + name + Tungsten-Fabric address group name + string + + + uuid + Tungsten-Fabric address group uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listBigSwitchBcfDevices + Lists BigSwitch BCF Controller devices + false + 4.6.0 + + + bcfdeviceid + bigswitch BCF controller device ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + bcfdeviceid + device id of the BigSwitch BCF Controller + string + + + bigswitchdevicename + device name + string + + + hostname + the controller Ip address + string + + + nat + NAT support + boolean + + + password + the controller password + string + + + physicalnetworkid + the physical network to which this BigSwitch BCF segment belongs to + string + + + provider + name of the provider + string + + + username + the controller username + string + + + false + + + listRegisteredServicePackages + lists registered service packages + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + Service Package UUID + string + + + description + Description of Service Package + string + + + name + Service Package Name + string + + + false + + + changeSharedFileSystemDiskOffering + Change Disk offering of a Shared FileSystem + true + 4.20.0 + + + id + the ID of the shared filesystem + true + uuid + + + diskofferingid + the disk offering to use for the underlying storage + false + uuid + + + maxiops + max iops + false + long + + + miniops + min iops + false + long + + + size + the size of the shared filesystem in GiB + false + long + + + + + id + ID of the shared filesystem + string + + + account + the account associated with the shared filesystem + string + + + description + description of the shared filesystem + string + + + diskioread + the read (IO) of disk on the shared filesystem + long + + + diskiowrite + the write (IO) of disk on the shared filesystem + long + + + diskkbsread + the shared filesystem's disk read in KiB + long + + + diskkbswrite + the shared filesystem's disk write in KiB + long + + + diskofferingdisplaytext + disk offering display text for the shared filesystem + string + + + diskofferingid + disk offering ID for the shared filesystem + string + + + diskofferingname + disk offering for the shared filesystem + string + + + domain + the domain associated with the shared filesystem + string + + + domainid + the ID of the domain associated with the shared filesystem + string + + + domainpath + path of the domain to which the shared filesystem + string + + + filesystem + the filesystem format + string + + + iscustomdiskoffering + disk offering for the shared filesystem has custom size + boolean + + + name + name of the shared filesystem + string + + + networkid + Network ID of the shared filesystem + string + + + networkname + Network name of the shared filesystem + string + + + path + path to mount the shared filesystem + string + + + physicalsize + the bytes actually consumed on disk + long + + + project + the project name of the shared filesystem + string + + + projectid + the project ID of the shared filesystem + string + + + provider + the shared filesystem provider + string + + + provisioningtype + provisioning type used in the shared filesystem + string + + + serviceofferingid + service offering ID for the shared filesystem + string + + + serviceofferingname + service offering for the shared filesystem + string + + + size + size of the shared filesystem + long + + + sizegb + size of the shared filesystem in GiB + string + + + state + the state of the shared filesystem + string + + + storage + name of the storage pool hosting the data volume + string + + + storageid + ID of the storage pool hosting the data volume + string + + + utilization + the disk utilization + string + + + virtualmachineid + ID of the storage fs vm + string + + + virtualsize + the bytes allocated + long + + + vmstate + ID of the storage fs vm + string + + + volumeid + ID of the storage fs data volume + string + + + volumename + name of the storage fs data volume + string + + + zoneid + ID of the availability zone + string + + + zonename + Name of the availability zone + string + + + nic(*) + the list of nics associated with the shared filesystem + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + list + + + false + + + enableStaticNat + Enables static NAT for given IP address + false + + + ipaddressid + the public IP address ID for which static NAT feature is being enabled + true + uuid + + + virtualmachineid + the ID of the virtual machine for enabling static NAT feature + true + uuid + + + networkid + The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case) + false + uuid + + + vmguestip + VM guest NIC secondary IP address for the port forwarding rule + false + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteZone + Deletes a Zone. + false + + + id + the ID of the Zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + expungeSharedFileSystem + Expunge a Shared FileSystem by id + true + 4.20.0 + + + id + the ID of the shared filesystem to expunge + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + getUploadParamsForTemplate + upload an existing template into the CloudStack cloud. + false + 4.6.0 + + + format + the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the volume/template/iso + true + string + + + zoneid + the ID of the zone the volume/template/iso is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + arch + the CPU arch of the template. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs. + false + map + map + + + displaytext + the display text of the template. This is usually used for display purposes. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file. + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Upload volume/template/iso for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + deleteSnapshotPolicies + Deletes snapshot policies for the account. + false + + + id + the Id of the snapshot policy + false + uuid + + + ids + list of snapshots policy IDs separated by comma + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTrafficTypeImplementors + Lists implementors of implementor of a network traffic type or implementors of all network traffic types + false + 3.0.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + traffictype + Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor + false + string + + + + + traffictype + network traffic type + string + + + traffictypeimplementor + implementor of network traffic type + string + + + false + + + listDbMetrics + list the db hosts and statistics + false + 4.17.0 + + + + collectiontime + the time these statistics were collected + date + + + connections + the number of connections to the DB + int + + + dbloadaverages + the last measured load averages on the DB + double[] + + + hostname + the name of the active usage server + string + + + queries + the number of queries performed on the DB + long + + + replicas + the state of the usage server + string[] + + + tlsversions + the tls versions currently in use (accepted) by the DB + string + + + uptime + the uptime of the DB in seconds + long + + + version + the version of the currently running DB + string + + + versioncomment + the version of the currently running DB + string + + + false + + + deleteImageStore + Deletes an image store or Secondary Storage. + false + 4.2.0 + + + id + The image store ID or Secondary Storage ID. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listAutoScaleVmProfiles + Lists autoscale vm profiles. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the autoscale vm profile + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + otherdeployparams + the otherdeployparameters of the autoscale vm profile + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + serviceofferingid + list profiles by service offering id + false + 4.4 + uuid + + + templateid + the templateid of the autoscale vm profile + false + uuid + + + zoneid + availability zone for the auto deployed virtual machine + false + 4.4 + uuid + + + + + id + the autoscale vm profile ID + string + + + account + the account owning the instance group + string + + + autoscaleuserid + the ID of the user used to launch and destroy the VMs + string + + + domain + the domain name of the vm profile + string + + + domainid + the domain ID of the vm profile + string + + + domainpath + path of the domain to which the vm profile belongs + 4.19.2.0 + string + + + expungevmgraceperiod + the time allowed for existing connections to get closed before a vm is destroyed + integer + + + fordisplay + is profile for display to the regular user + 4.4 + boolean + + + otherdeployparams + parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine + map + + + project + the project name of the vm profile + string + + + projectid + the project id vm profile + string + + + serviceofferingid + the service offering to be used while deploying a virtual machine + string + + + templateid + the template to be used while deploying a virtual machine + string + + + userdata + Base64 encoded VM user data + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.1 + string + + + userdataid + the id of userdata used for the VM + 4.18.1 + string + + + userdataname + the name of userdata used for the VM + 4.18.1 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.1 + string + + + zoneid + the availability zone to be used while deploying a virtual machine + string + + + false + + + authorizeSecurityGroupIngress + Authorizes a particular ingress rule for this security group + true + + + account + an optional account for the security group. Must be used with domainId. + false + string + + + cidrlist + the cidr list associated. Multiple entries must be separated by a single comma character (,). + false + list + list + + + domainid + an optional domainId for the security group. If the account parameter is used, domainId must also be used. + false + uuid + + + endport + end port for this ingress rule + false + integer + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the icmp message being sent + false + integer + + + projectid + an optional project of the security group + false + uuid + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default. + false + string + + + securitygroupid + The ID of the security group. Mutually exclusive with securityGroupName parameter + false + uuid + + + securitygroupname + The name of the security group. Mutually exclusive with securityGroupId parameter + false + string + + + startport + start port for this ingress rule + false + integer + + + usersecuritygrouplist + user to security group mapping + false + map + map + + + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + false + + + syncStoragePool + Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it) + true + 4.15.1 + + + id + Storage pool id + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateBucket + Updates Bucket properties + false + 4.19.0 + + + id + The ID of the Bucket + true + uuid + + + encryption + Enable/Disable Bucket encryption + false + boolean + + + policy + Bucket Access Policy + false + string + + + quota + Bucket Quota in GB + false + integer + + + versioning + Enable/Disable Bucket Versioning + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateResourceCount + Recalculate and update resource count for an account or domain. This also executes some cleanup tasks before calculating resource counts. + false + + + domainid + If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain. + true + uuid + + + account + Update resource count for a specified account. Must be used with the domainId parameter. + false + string + + + projectid + Update resource limits for project + false + uuid + + + resourcetype + Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. + false + integer + + + tag + Tag for the resource type + false + 4.20.0 + string + + + + + account + the account for which resource count's are updated + string + + + domain + the domain name for which resource count's are updated + string + + + domainid + the domain ID for which resource count's are updated + string + + + domainpath + path of the domain to which the resource counts are updated + 4.19.2.0 + string + + + project + the project name for which resource count's are updated + string + + + projectid + the project id for which resource count's are updated + string + + + resourcecount + The resource count + long + + + resourcetype + resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values. + string + + + resourcetypename + resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage. + string + + + tag + Tag for the resource + 4.20.0 + string + + + false + + + listRoles + Lists dynamic roles in CloudStack + false + 4.9.0 + + + id + List role by role ID. + false + uuid + + + keyword + List by keyword + false + string + + + name + List role by role name. + false + string + + + page + false + integer + + + pagesize + false + integer + + + state + List role by role type status, valid options are: enabled, disabled + false + string + + + type + List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User. + false + string + + + + + isdefault + true if role is default, false otherwise + boolean + + + state + the state of the role + string + + + type + the type of the role + string + + + false + + + listTungstenFabricPolicy + list Tungsten-Fabric policy + false + + + ipaddressid + the ID of ip address + false + uuid + + + keyword + List by keyword + false + string + + + networkid + the ID of network + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + policyuuid + the uuid of Tungsten-Fabric policy + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric policy name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + downloadImageStoreObject + Download object at a specified path on an image store. + true + 4.19.0 + + + id + id of the image store + true + uuid + + + path + path to download on image store + false + string + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + getCloudIdentifier + Retrieves a cloud identifier. + false + + + userid + the user ID for the cloud identifier + true + uuid + + + + + cloudidentifier + the cloud identifier + string + + + signature + the signed response for the cloud identifier + string + + + userid + the user ID for the cloud identifier + string + + + false + + + createLBStickinessPolicy + Creates a load balancer stickiness policy + true + 3.0.0 + + + lbruleid + the ID of the load balancer rule + true + uuid + + + methodname + name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased + true + string + + + name + name of the load balancer stickiness policy + true + string + + + description + the description of the load balancer stickiness policy + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + param + param list. Example: param[0].name=cookiename&param[0].value=LBCookie + false + map + map + + + + + account + the account of the Stickiness policy + string + + + description + the description of the Stickiness policy + string + + + domain + the domain of the Stickiness policy + string + + + domainid + the domain ID of the Stickiness policy + string + + + lbruleid + the LB rule ID + string + + + name + the name of the Stickiness policy + string + + + state + the state of the policy + string + + + zoneid + the id of the zone the Stickiness policy belongs to + string + + + stickinesspolicy(*) + the list of stickinesspolicies + + + id + the LB Stickiness policy ID + string + + + description + the description of the Stickiness policy + string + + + fordisplay + is policy for display to the regular user + 4.4 + boolean + + + methodname + the method name of the Stickiness policy + string + + + name + the name of the Stickiness policy + string + + + params + the params of the policy + map + + + state + the state of the policy + string + + + list + + + false + + + addCiscoAsa1000vResource + Adds a Cisco Asa 1000v appliance + false + + + clusterid + the Cluster ID + true + uuid + + + hostname + Hostname or ip address of the Cisco ASA 1000v appliance. + true + string + + + insideportprofile + Nexus port profile associated with inside interface of ASA 1000v + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + + false + + + configurePaloAltoFirewall + Configures a Palo Alto firewall device + true + + + fwdeviceid + Palo Alto firewall device ID + true + uuid + + + fwdevicecapacity + capacity of the firewall device, Capacity will be interpreted as number of networks device can handle + false + long + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + updateNetworkACLItem + Updates ACL item with specified ID + true + + + id + the ID of the network ACL item + true + uuid + + + action + scl entry action, allow or deny + false + string + + + cidrlist + the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). + false + list + list + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + endport + the ending port of ACL + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this ICMP message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + number + The network of the vm the ACL will be created for + false + integer + + + partialupgrade + Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'. + false + boolean + + + protocol + the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number + false + string + + + reason + A description indicating why the ACL rule is required. + false + string + + + startport + the starting port of ACL + false + integer + + + traffictype + the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listRouters + List routers. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + clusterid + the cluster ID of the router + false + uuid + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fetchhealthcheckresults + if true is passed for this parameter, also fetch last executed health check results for the router. Default is false + false + 4.14 + boolean + + + forvpc + if true is passed for this parameter, list only VPC routers + false + boolean + + + healthchecksfailed + if this parameter is passed, list only routers by health check results + false + 4.16 + boolean + + + hostid + the host ID of the router + false + uuid + + + id + the ID of the disk router + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the router + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + podid + the Pod ID of the router + false + uuid + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + the state of the router + false + string + + + version + list virtual router elements by version + false + string + + + vpcid + List networks by VPC + false + uuid + + + zoneid + the Zone ID of the router + false + uuid + + + + + id + the id of the router + string + + + account + the account associated with the router + string + + + created + the date and time the router was created + date + + + dns1 + the first DNS for the router + string + + + dns2 + the second DNS for the router + string + + + domain + the domain associated with the router + string + + + domainid + the domain ID associated with the router + string + + + domainpath + path of the Domain the router belongs to + 4.19.2.0 + string + + + gateway + the gateway for the router + string + + + guestipaddress + the guest IP address for the router + string + + + guestmacaddress + the guest MAC address for the router + string + + + guestnetmask + the guest netmask for the router + string + + + guestnetworkid + the ID of the corresponding guest network + string + + + guestnetworkname + the name of the corresponding guest network + string + + + healthchecksfailed + true if any health checks had failed + boolean + + + hostcontrolstate + the control state of the host for the router + string + + + hostid + the host ID for the router + string + + + hostname + the hostname for the router + string + + + hypervisor + the hypervisor on which the template runs + string + + + ip6dns1 + the first IPv6 DNS for the router + string + + + ip6dns2 + the second IPv6 DNS for the router + string + + + isredundantrouter + if this router is an redundant virtual router + boolean + + + linklocalip + the link local IP address for the router + string + + + linklocalmacaddress + the link local MAC address for the router + string + + + linklocalnetmask + the link local netmask for the router + string + + + linklocalnetworkid + the ID of the corresponding link local network + string + + + name + the name of the router + string + + + networkdomain + the network domain for the router + string + + + podid + the Pod ID for the router + string + + + podname + the Pod name for the router + 4.13.2 + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicip + the public IP address for the router + string + + + publicmacaddress + the public MAC address for the router + string + + + publicnetmask + the public netmask for the router + string + + + publicnetworkid + the ID of the corresponding public network + string + + + redundantstate + the state of redundant virtual router + string + + + requiresupgrade + true if the router template requires upgrader + boolean + + + role + role of the domain router + string + + + scriptsversion + the version of scripts + string + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + softwareversion + the version of the code / software in the router + string + + + state + the state of the router + state + + + templateid + the template ID for the router + string + + + templatename + the template name for the router + 4.13.2 + string + + + version + the version of template + string + + + vpcid + VPC the router belongs to + string + + + vpcname + the name of VPC the router belongs to + string + + + zoneid + the Zone ID for the router + string + + + zonename + the Zone name for the router + string + + + healthcheckresults(*) + Last executed health check result for the router + 4.14 + + + checkname + the name of the health check on the router + string + + + checktype + the type of the health check - basic or advanced + string + + + details + detailed response generated on running health check + string + + + lastupdated + the date this VPC was created + date + + + success + result of the health check + boolean + + + list + + + nic(*) + the list of nics associated with the router + 4.0 + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + listTungstenFabricVm + list Tungsten-Fabric vm + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + vmuuid + the uuid of Tungsten-Fabric vm + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric vm name + string + + + uuid + Tungsten-Fabric nic uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + deletePhysicalNetwork + Deletes a Physical Network. + true + 3.0.0 + + + id + the ID of the Physical network + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addTungstenFabricPolicyRule + add Tungsten-Fabric policy rule + true + + + action + Tungsten-Fabric policy rule action + true + string + + + destendport + Tungsten-Fabric policy rule destination end port + true + integer + + + destipprefix + Tungsten-Fabric policy rule destination ip prefix + true + string + + + destipprefixlen + Tungsten-Fabric policy rule destination ip prefix length + true + integer + + + destnetwork + Tungsten-Fabric policy rule destination network + true + string + + + deststartport + Tungsten-Fabric policy rule destination start port + true + integer + + + direction + Tungsten-Fabric policy rule direction + true + string + + + policyuuid + the uuid of Tungsten-Fabric policy + true + string + + + protocol + Tungsten-Fabric policy rule protocol + true + string + + + srcendport + Tungsten-Fabric policy rule source end port + true + integer + + + srcipprefix + Tungsten-Fabric policy rule source ip prefix + true + string + + + srcipprefixlen + Tungsten-Fabric policy rule source ip prefix length + true + integer + + + srcnetwork + Tungsten-Fabric policy rule source network + true + string + + + srcstartport + Tungsten-Fabric policy rule source start port + true + integer + + + zoneid + the ID of zone + true + uuid + + + + + action + Tungsten-Fabric policy action + string + + + destendport + Tungsten-Fabric policy destination end port + int + + + destipprefix + Tungsten-Fabric policy destination ip prefix + string + + + destipprefixlen + Tungsten-Fabric policy destination ip prefix length + int + + + destnetwork + Tungsten-Fabric policy destination network + string + + + deststartport + Tungsten-Fabric policy destination start port + int + + + direction + Tungsten-Fabric policy name + string + + + policyuuid + Tungsten-Fabric policy uuid + string + + + protocol + Tungsten-Fabric policy protocol + string + + + srcendport + Tungsten-Fabric policy source end port + int + + + srcipprefix + Tungsten-Fabric policy source ip prefix + string + + + srcipprefixlen + Tungsten-Fabric policy source ip prefix length + int + + + srcnetwork + Tungsten-Fabric policy source network + string + + + srcstartport + Tungsten-Fabric policy source start port + int + + + uuid + Tungsten-Fabric rule uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + createWebhook + Creates a Webhook + false + 4.20.0 + + + name + Name for the Webhook + true + string + + + payloadurl + Payload URL of the Webhook + true + string + + + account + An optional account for the Webhook. Must be used with domainId. + false + string + + + description + Description for the Webhook + false + string + + + domainid + an optional domainId for the Webhook. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + Project for the Webhook + false + uuid + + + scope + Scope of the Webhook + false + string + + + secretkey + Secret key of the Webhook + false + string + + + sslverification + If set to true then SSL verification will be done for the Webhook otherwise not + false + boolean + + + state + State of the Webhook + false + string + + + + + id + The ID of the Webhook + string + + + account + The account associated with the Webhook + string + + + created + The date when this Webhook was created + date + + + description + The description of the Webhook + string + + + domain + The name of the domain in which the Webhook exists + string + + + domainid + The ID of the domain in which the Webhook exists + string + + + domainpath + path of the domain to which the Webhook belongs + string + + + name + The name of the Webhook + string + + + payloadurl + The payload URL end point for the Webhook + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + scope + The scope of the Webhook + string + + + secretkey + The secret key for the Webhook + string + + + sslverification + Whether SSL verification is enabled for the Webhook + boolean + + + state + The state of the Webhook + string + + + false + + + removeVpnUser + Removes vpn user + true + + + username + username for the vpn user + true + string + + + account + an optional account for the vpn user. Must be used with domainId. + false + string + + + domainid + an optional domainId for the vpn user. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + remove vpn user from the project + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listQuarantinedIps + List public IP addresses in quarantine. + false + 4.19 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + showinactive + Show IPs that are no longer in quarantine. + false + boolean + + + showremoved + Show IPs removed from quarantine. + false + boolean + + + + + id + ID of the quarantine process. + string + + + created + When the quarantine was created. + date + + + enddate + End date for the quarantine. + date + + + ipaddress + The public IP address in quarantine. + string + + + previousownerid + Account ID of the previous public IP address owner. + string + + + previousownername + Account name of the previous public IP address owner. + string + + + removalreason + The reason for removing the IP from quarantine prematurely. + string + + + removed + When the quarantine was removed. + date + + + removeraccountid + ID of the account that removed the IP from quarantine. + string + + + false + + + deleteLBHealthCheckPolicy + Deletes a load balancer health check policy. + true + 4.2.0 + + + id + the ID of the load balancer health check policy + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSwifts + List Swift. + false + 3.0.0 + + + id + the id of the swift + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the image store + string + + + disksizetotal + the total disk size of the host + long + + + disksizeused + the host's currently used disk size + long + + + name + the name of the image store + string + + + protocol + the protocol of the image store + string + + + providername + the provider name of the image store + string + + + readonly + defines if store is read-only + boolean + + + scope + the scope of the image store + scopetype + + + url + the url of the image store + string + + + zoneid + the Zone ID of the image store + string + + + zonename + the Zone name of the image store + string + + + false + + + disableHAForHost + Disables HA for a host + true + 4.11 + + + hostid + ID of the host + true + uuid + + + + + haenable + if host HA is enabled for the host + boolean + + + haprovider + the host HA provider + string + + + hastate + the HA state of the host + hastate + + + hostid + the ID of the host + string + + + status + operation status + boolean + + + false + + + enableOutOfBandManagementForHost + Enables out-of-band management for a host + true + 4.9.0 + + + hostid + the ID of the host + true + uuid + + + + + action + the out-of-band management action (if issued) + string + + + address + the out-of-band management interface address + string + + + description + the operation result description + string + + + driver + the out-of-band management driver for the host + string + + + enabled + true if out-of-band management is enabled for the host + boolean + + + hostid + the ID of the host + string + + + password + the out-of-band management interface password + string + + + port + the out-of-band management interface port + string + + + powerstate + the out-of-band management interface powerState of the host + powerstate + + + status + the operation result + boolean + + + username + the out-of-band management interface username + string + + + false + + + listKubernetesSupportedVersions + Lists supported Kubernetes version + false + + + id + the ID of the Kubernetes supported version + false + uuid + + + keyword + List by keyword + false + string + + + minimumkubernetesversionid + the ID of the minimum Kubernetes supported version + false + uuid + + + minimumsemanticversion + the minimum semantic version for the Kubernetes supported version to be listed + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + the ID of the zone in which Kubernetes supported version will be available + false + uuid + + + + + id + the id of the Kubernetes supported version + string + + + created + the date when this Kubernetes supported version was created + date + + + directdownload + KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage + 4.18.2 + boolean + + + isoid + the id of the binaries ISO for Kubernetes supported version + string + + + isoname + the name of the binaries ISO for Kubernetes supported version + string + + + isostate + the state of the binaries ISO for Kubernetes supported version + string + + + mincpunumber + the minimum number of CPUs needed for the Kubernetes supported version + integer + + + minmemory + the minimum RAM size in MB needed for the Kubernetes supported version + integer + + + name + Name of the Kubernetes supported version + string + + + semanticversion + Kubernetes semantic version + string + + + state + the enabled or disabled state of the Kubernetes supported version + string + + + supportsautoscaling + whether Kubernetes supported version supports Autoscaling + boolean + + + supportsha + whether Kubernetes supported version supports HA, multi-control nodes + boolean + + + zoneid + the id of the zone in which Kubernetes supported version is available + string + + + zonename + the name of the zone in which Kubernetes supported version is available + string + + + false + + + deleteServiceOffering + Deletes a service offering. + false + + + id + the ID of the service offering + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + addNiciraNvpDevice + Adds a Nicira NVP device + true + + + hostname + Hostname of ip address of the Nicira NVP Controller. + true + string + + + password + Credentials to access the Nicira Controller API + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + transportzoneuuid + The Transportzone UUID configured on the Nicira Controller + true + string + + + username + Credentials to access the Nicira Controller API + true + string + + + l2gatewayserviceuuid + The L2 Gateway Service UUID configured on the Nicira Controller + false + string + + + l3gatewayserviceuuid + The L3 Gateway Service UUID configured on the Nicira Controller + false + string + + + + + hostname + the controller Ip address + string + + + l2gatewayserviceuuid + this L2 gateway service Uuid + string + + + l3gatewayserviceuuid + this L3 gateway service Uuid + string + + + niciradevicename + device name + string + + + nvpdeviceid + device id of the Nicire Nvp + string + + + physicalnetworkid + the physical network to which this Nirica Nvp belongs to + string + + + provider + name of the provider + string + + + transportzoneuuid + the transport zone Uuid + string + + + false + + + listInfrastructure + Lists infrastructure + false + 4.9.3 + + + + alerts + Number of Alerts + integer + + + clusters + Number of clusters + integer + + + cpusockets + Number of cpu sockets + integer + + + hosts + Number of hypervisor hosts + integer + + + ilbvms + Number of internal LBs + integer + + + imagestores + Number of images stores + integer + + + managementservers + Number of management servers + integer + + + objectstores + Number of object stores + integer + + + pods + Number of pods + integer + + + routers + Number of routers + integer + + + storagepools + Number of storage pools + integer + + + systemvms + Number of systemvms + integer + + + zones + Number of zones + integer + + + false + + + listUsageRecords + Lists usage records for accounts + false + + + enddate + End date range for usage record query. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone. + true + date + + + startdate + Start date range for usage record query. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "00:00:00"). If the recommended format is not used, the date will be considered in the server timezone. + true + date + + + account + List usage records for the specified user. + false + string + + + accountid + List usage records for the specified account + false + uuid + + + domainid + List usage records for the specified domain. + false + uuid + + + includetags + Flag to enable display of Tags for a resource + false + boolean + + + isrecursive + Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account. + false + 4.15 + boolean + + + keyword + List by keyword + false + string + + + oldformat + Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default. + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + projectid + List usage records for specified project + false + uuid + + + type + List usage records for the specified usage type + false + long + + + usageid + List usage records for the specified usage UUID. Can be used only together with TYPE parameter. + false + string + + + + + account + the user account name + string + + + accountid + the user account Id + string + + + cpunumber + number of cpu of resource + long + + + cpuspeed + speed of each cpu of resource + long + + + description + description of the usage record + string + + + domain + the domain the resource is associated with + string + + + domainid + the domain ID + string + + + domainpath + path of the domain to which the usage reocrd belongs + 4.19.2.0 + string + + + enddate + end date of the usage record + date + + + isdefault + True if the resource is default + boolean + + + issourcenat + True if the IPAddress is source NAT + boolean + + + issystem + True if the IPAddress is system IP - allocated during vm deploy or lb rule create + boolean + + + memory + memory allocated for the resource + long + + + name + resource or virtual machine name + string + + + networkid + id of the network + string + + + offeringid + offering ID + string + + + oscategoryid + virtual machine guest os category ID + string + + + oscategoryname + virtual machine os category name + string + + + osdisplayname + virtual machine os display name + string + + + ostypeid + virtual machine os type ID + string + + + project + the project name of the resource + string + + + projectid + the project id of the resource + string + + + rawusage + raw usage in hours + string + + + size + resource size + long + + + startdate + start date of the usage record + date + + + templateid + template ID + string + + + type + resource type + string + + + usage + usage in hours + string + + + usageid + id of the resource + string + + + usagetype + usage type ID + integer + + + virtualmachineid + virtual machine ID + string + + + virtualsize + virtual size of resource + long + + + vpcid + id of the vpc + string + + + zoneid + the zone ID + string + + + false + + + recoverVolume + Recovers a Destroy volume. + false + 4.14.0 + + + id + The ID of the volume + true + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeTungstenFabricNetworkGatewayFromLogicalRouter + remove Tungsten-Fabric network gateway from logical router + true + + + logicalrouteruuid + Tungsten-Fabric logical router uuid + true + string + + + networkuuid + Tungsten-Fabric network uuid + true + string + + + zoneid + the ID of zone + true + uuid + + + + + name + Tungsten-Fabric logical router name + string + + + network + list Tungsten-Fabric policy network name + list + + + uuid + Tungsten-Fabric logical router uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + listVolumesForImport + Lists unmanaged volumes on a storage pool + false + 4.19.1 + + + storageid + the ID of the storage pool + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + path + the path of the volume on the storage pool + false + string + + + + + chaininfo + the chain info of the volume + string + + + details + volume details in key/value pairs. + map + + + encryptformat + the encrypt format of the volume + string + + + format + the format of the volume + string + + + fullpath + the full path of the volume + string + + + name + the name of the volume + string + + + path + the path of the volume + string + + + size + the size of the volume + long + + + storage + name of the primary storage hosting the volume + string + + + storageid + id of the primary storage hosting the volume + string + + + storagetype + type of the primary storage hosting the volume + string + + + virtualsize + the virtual size of the volume + long + + + false + + + listZonesMetrics + Lists zone metrics + false + 4.9.3 + + + available + true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false. + false + boolean + + + domainid + the ID of the domain associated with the zone + false + uuid + + + id + the ID of the zone + false + uuid + + + ids + the IDs of the zones, mutually exclusive with id + false + list + 4.19.0 + list + + + keyword + List by keyword + false + string + + + name + the name of the zone + false + string + + + networktype + the network type of the zone that the virtual machine belongs to + false + string + + + page + false + integer + + + pagesize + false + integer + + + showcapacities + flag to display the capacity of the zones + false + boolean + + + showicon + flag to display the resource image for the zones + false + boolean + + + tags + List zones by resource tags (key/value pairs) + false + map + 4.3 + map + + + + + clusters + healthy / total clusters in the zone + string + + + cpuallocated + the total cpu allocated in Ghz + string + + + cpuallocateddisablethreshold + cpu allocated disable threshold exceeded + boolean + + + cpuallocatedthreshold + cpu allocated notification threshold exceeded + boolean + + + cpudisablethreshold + cpu usage disable threshold exceeded + boolean + + + cpumaxdeviation + the maximum cpu deviation + string + + + cputhreshold + cpu usage notification threshold exceeded + boolean + + + cputotal + the total cpu capacity in Ghz + string + + + cpuused + the total cpu used in Ghz + string + + + memoryallocated + the total cpu allocated in GiB + string + + + memoryallocateddisablethreshold + memory allocated disable threshold exceeded + boolean + + + memoryallocatedthreshold + memory allocated notification threshold exceeded + boolean + + + memorydisablethreshold + memory usage disable threshold exceeded + boolean + + + memorymaxdeviation + the maximum memory deviation + string + + + memorythreshold + memory usage notification threshold exceeded + boolean + + + memorytotal + the total cpu capacity in GiB + string + + + memoryused + the total cpu used in GiB + string + + + state + state of the cluster + string + + + false + + + extractTemplate + Extracts a template + true + + + id + the ID of the template + true + uuid + + + mode + the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD + true + string + + + url + the url to which the ISO would be extracted + false + string + + + zoneid + the ID of the zone where the ISO is originally located + false + uuid + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + expungeVirtualMachine + Expunge a virtual machine. Once expunged, it cannot be recoverd. + true + + + id + The ID of the virtual machine + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateIpAddress + Updates an IP address + true + + + id + the ID of the public IP address to update + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the IP to the end user or not + false + 4.4 + boolean + + + + + id + public IP address id + string + + + account + the account the public IP address is associated with + string + + + allocated + date the public IP address was acquired + date + + + associatednetworkid + the ID of the Network associated with the IP address + string + + + associatednetworkname + the name of the Network associated with the IP address + string + + + domain + the domain the public IP address is associated with + string + + + domainid + the domain ID the public IP address is associated with + string + + + domainpath + path of the domain to which the public IP address belongs + 4.19.2.0 + string + + + fordisplay + is public ip for display to the regular user + 4.4 + boolean + + + forsystemvms + true if range is dedicated for System VMs + boolean + + + forvirtualnetwork + the virtual network for the IP address + boolean + + + hasrules + whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined + boolean + + + ipaddress + public IP address + string + + + isportable + is public IP portable across the zones + boolean + + + issourcenat + true if the IP address is a source nat address, false otherwise + boolean + + + isstaticnat + true if this ip is for static nat, false otherwise + boolean + + + issystem + true if this ip is system ip (was allocated as a part of deployVm or createLbRule) + boolean + + + networkid + the ID of the Network where ip belongs to + string + + + networkname + the name of the Network where ip belongs to + string + + + physicalnetworkid + the physical network this belongs to + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + purpose + purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value + string + + + state + State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free + string + + + virtualmachinedisplayname + virtual machine display name the ip address is assigned to (not null only for static nat Ip) + string + + + virtualmachineid + virtual machine id the ip address is assigned to + string + + + virtualmachinename + virtual machine name the ip address is assigned to + string + + + virtualmachinetype + virtual machine type the ip address is assigned to + 4.19.0 + string + + + vlanid + the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only + string + + + vlanname + the VLAN associated with the IP address + string + + + vmipaddress + virtual machine (dnat) ip address (not null only for static nat Ip) + string + + + vpcid + VPC id the ip belongs to + string + + + vpcname + VPC name the ip belongs to + 4.13.2 + string + + + zoneid + the ID of the zone the public IP address belongs to + string + + + zonename + the name of the zone the public IP address belongs to + string + + + tags(*) + the list of resource tags associated with ip address + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + migrateNetwork + moves a network to another physical network + true + 4.11.0 + + + networkid + the ID of the network + true + uuid + + + networkofferingid + network offering ID + true + uuid + + + resume + true if previous network migration cmd failed + false + boolean + + + + + id + the id of the network + string + + + account + the owner of the network + string + + + aclid + ACL Id associated with the VPC network + string + + + aclname + ACL name associated with the VPC network + string + + + acltype + acl type - access type to the network + string + + + asnumber + AS NUMBER + 4.20.0 + long + + + asnumberid + UUID of AS NUMBER + 4.20.0 + string + + + associatednetwork + the name of the Network associated with this network + string + + + associatednetworkid + the ID of the Network associated with this network + string + + + bgppeers + The BGP peers for the network + 4.20.0 + set + + + broadcastdomaintype + Broadcast domain type of the network + string + + + broadcasturi + broadcast uri of the network. This parameter is visible to ROOT admins only + string + + + canusefordeploy + list networks available for vm deployment + boolean + + + cidr + Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR + string + + + created + the date this network was created + 4.16.0 + date + + + details + the details of the network + map + + + displaynetwork + an optional field, whether to the display the network to the end user or not. + boolean + + + displaytext + the displaytext of the network + string + + + dns1 + the first IPv4 DNS for the network + string + + + dns2 + the second IPv4 DNS for the network + string + + + domain + the domain name of the network owner + string + + + domainid + the domain id of the network owner + string + + + domainpath + path of the Domain the network belongs to + 4.19.0.0 + string + + + egressdefaultpolicy + true if guest network default egress policy is allow; false if default egress policy is deny + boolean + + + externalid + The external id of the network + 4.11 + string + + + gateway + the network's gateway + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + internetprotocol + The internet protocol of network offering + string + + + ip4routes + The routes for the network to ease adding route in upstream router + 4.20.0 + set + + + ip4routing + The IPv4 routing type of network + 4.20.0 + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6dns1 + the first IPv6 DNS for the network + 4.18.0 + string + + + ip6dns2 + the second IPv6 DNS for the network + 4.18.0 + string + + + ip6gateway + the gateway of IPv6 network + string + + + ip6routes + The routes for the network to ease adding route in upstream router + 4.17.0 + set + + + ip6routing + The Ipv6 routing type of network offering + 4.17.0 + string + + + isdefault + true if network is default, false otherwise + boolean + + + ispersistent + list networks that are persistent + boolean + + + issystem + true if network is system, false otherwise + boolean + + + name + the name of the network + string + + + netmask + the network's netmask + string + + + networkcidr + the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE + string + + + networkdomain + the network domain + string + + + networkofferingavailability + availability of the network offering the network is created from + string + + + networkofferingconservemode + true if network offering is ip conserve mode enabled + boolean + + + networkofferingdisplaytext + display text of the network offering the network is created from + string + + + networkofferingid + network offering id the network is created from + string + + + networkofferingname + name of the network offering the network is created from + string + + + physicalnetworkid + the physical network id + string + + + privatemtu + MTU configured on the network VR's private interfaces + integer + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + publicmtu + MTU configured on the network VR's public facing interfaces + integer + + + receivedbytes + the total number of network traffic bytes received + long + + + redundantrouter + If the network has redundant routers enabled + 4.11.1 + boolean + + + related + related to what other network configuration + string + + + reservediprange + the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes + string + + + restartrequired + true network requires restart + boolean + + + sentbytes + the total number of network traffic bytes sent + long + + + specifyipranges + true if network supports specifying ip ranges, false otherwise + boolean + + + state + state of the network + string + + + strechedl2subnet + true if network can span multiple zones + 4.4 + boolean + + + subdomainaccess + true if users from subdomains can access the domain level network + boolean + + + supportsvmautoscaling + if network offering supports vm autoscaling feature + 4.18.0 + boolean + + + traffictype + the traffic type of the network + string + + + tungstenvirtualrouteruuid + Tungsten-Fabric virtual router the network belongs to + string + + + type + the type of the network + string + + + vlan + The vlan of the network. This parameter is visible to ROOT admins only + string + + + vpcid + VPC the network belongs to + string + + + vpcname + Name of the VPC to which this network belongs + 4.15 + string + + + zoneid + zone id of the network + string + + + zonename + the name of the zone the network belongs to + string + + + zonesnetworkspans + If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans + 4.4 + set + + + service(*) + the list of services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + tags(*) + the list of resource tags associated with network + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listUnmanagedInstances + Lists unmanaged virtual machines for a given cluster. + false + 4.14.0 + + + clusterid + the cluster ID + true + uuid + + + keyword + List by keyword + false + string + + + name + the hypervisor name of the instance + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + clusterid + the ID of the cluster to which virtual machine belongs + string + + + clustername + the name of the cluster to which virtual machine belongs + string + + + cpucorepersocket + the CPU cores per socket for the virtual machine. VMware specific + integer + + + cpunumber + the CPU cores of the virtual machine + integer + + + cpuspeed + the CPU speed of the virtual machine + integer + + + hostid + the ID of the host to which virtual machine belongs + string + + + hostname + the name of the host to which virtual machine belongs + string + + + memory + the memory of the virtual machine in MB + integer + + + name + the name of the virtual machine + string + + + osdisplayname + the operating system of the virtual machine + string + + + osid + the operating system ID of the virtual machine + string + + + powerstate + the power state of the virtual machine + string + + + disk(*) + the list of disks associated with the virtual machine + + + id + the ID of the disk + string + + + capacity + the capacity of the disk in bytes + long + + + controller + the controller of the disk + string + + + controllerunit + the controller unit of the disk + integer + + + datastorehost + the controller of the disk + string + + + datastorename + the controller of the disk + string + + + datastorepath + the controller of the disk + string + + + datastoretype + the controller of the disk + string + + + imagepath + the file path of the disk image + string + + + label + the label of the disk + string + + + position + the position of the disk + integer + + + set + + + nic(*) + the list of nics associated with the virtual machine + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + false + + + registerTemplate + Registers an existing template into the CloudStack cloud. + false + + + format + the format for the template. Possible values include QCOW2, RAW, VHD and OVA. + true + string + + + hypervisor + the target hypervisor for the template + true + string + + + name + the name of the template + true + string + + + url + the URL of where the template is hosted. Possible URL include http:// and https:// + true + string + + + account + an optional accountName. Must be used with domainId. + false + string + + + arch + the CPU arch of the template. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + bits + 32 or 64 bits support. 64 by default + false + integer + + + checksum + the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + deployasis + (VMware only) true if VM deployments should preserve all the configurations defined for this template + false + 4.15.1 + boolean + + + details + Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + directdownload + true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment + false + boolean + + + displaytext + The display text of the template, defaults to 'name'. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isextractable + true if the template or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if this template is a featured template, false otherwise + false + boolean + + + ispublic + true if the template is available to all accounts; default is true + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + ostypeid + the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template + false + uuid + + + passwordenabled + true if the template supports the password reset feature; default is false + false + boolean + + + projectid + Register template for the project + false + uuid + + + requireshvm + true if this template requires HVM + false + boolean + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + string + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + 4.19.0 + string + + + zoneid + the ID of the zone the template is to be hosted on + false + uuid + + + zoneids + A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. + false + list + list + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listVnfAppliances + List VNF appliance owned by the account. + false + 4.19.1 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + accumulate + Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. + false + 4.17.0 + boolean + + + affinitygroupid + list vms by affinity group + false + uuid + + + autoscalevmgroupid + the ID of AutoScaling VM Group + false + 4.18.0 + uuid + + + backupofferingid + list by the backup offering + false + 4.17 + uuid + + + details + comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. + false + list + list + + + displayvm + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + domainid + list only resources belonging to the domain specified + false + uuid + + + forvirtualnetwork + list by network type; true if need to list vms using Virtual Network, false otherwise + false + boolean + + + groupid + the group ID + false + uuid + + + haenable + list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled + false + 4.15 + boolean + + + hypervisor + the target hypervisor for the template + false + string + + + id + the ID of the virtual machine + false + uuid + + + ids + the IDs of the virtual machines, mutually exclusive with id + false + list + 4.4 + list + + + isoid + list vms by iso + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + isvnf + flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. + false + 4.19.0 + boolean + + + keypair + list vms by ssh keypair name + false + string + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) + false + string + + + networkid + list by network id + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + retrieveonlyresourcecount + makes the API's response contains only the resource count + false + boolean + + + securitygroupid + the security group ID + false + 4.15 + uuid + + + serviceofferingid + list by the service offering + false + 4.4 + uuid + + + showicon + flag to display the resource icon for VMs + false + 4.16.0.0 + boolean + + + state + state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + templateid + list vms by template + false + uuid + + + userdata + Whether to return the VMs' user data or not. By default, user data will not be returned. + false + 4.18.0.0 + boolean + + + userid + the user ID that created the VM and is under the account that owns the VM + false + uuid + + + vpcid + list vms by vpc + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + addStratosphereSsp + Adds stratosphere ssp server + false + + + name + stratosphere ssp api name + true + string + + + url + stratosphere ssp server url + true + string + + + zoneid + the zone ID + true + uuid + + + password + stratosphere ssp api password + false + string + + + tenantuuid + stratosphere ssp tenant uuid + false + string + + + username + stratosphere ssp api username + false + string + + + + + hostid + server id of the stratosphere ssp server + string + + + name + name + string + + + url + url of ssp endpoint + string + + + zoneid + zone which this ssp controls + string + + + false + + + createStoragePool + Creates a storage pool. + false + + + name + the name for the storage pool + true + string + + + url + the URL of the storage pool + true + string + + + zoneid + the Zone ID for the storage pool + true + uuid + + + capacitybytes + bytes CloudStack can provision from this storage pool + false + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + false + long + + + clusterid + the cluster ID for the storage pool + false + uuid + + + details + the details for the storage pool + false + map + map + + + hypervisor + hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now. + false + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + false + boolean + + + managed + whether the storage should be managed by CloudStack + false + boolean + + + podid + the Pod ID for the storage pool + false + uuid + + + provider + the storage provider name + false + string + + + scope + the scope of the storage: cluster or zone + false + string + + + tags + the tags for the storage pool + false + string + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + findStoragePoolsForMigration + Lists storage pools available for migration of a volume. + false + + + id + the ID of the volume + true + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteTungstenFabricFirewallRule + delete Tungsten-Fabric firewall rule + true + + + firewallruleuuid + the uuid of Tungsten-Fabric firewall rule + true + string + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + disableCiscoNexusVSM + disable a Cisco Nexus VSM device + true + + + id + Id of the Cisco Nexus 1000v VSM device to be deleted + true + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + createStorageNetworkIpRange + Creates a Storage network IP range. + true + 3.0.0 + + + gateway + the gateway for storage network + true + string + + + netmask + the netmask for storage network + true + string + + + podid + UUID of pod where the ip range belongs to + true + uuid + + + startip + the beginning IP address + true + string + + + endip + the ending IP address + false + string + + + vlan + Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table + false + integer + + + + + id + the uuid of storage network IP range. + string + + + endip + the end ip of the storage network IP range + string + + + gateway + the gateway of the storage network IP range + string + + + netmask + the netmask of the storage network IP range + string + + + networkid + the network uuid of storage network IP range + string + + + podid + the Pod uuid for the storage network IP range + string + + + startip + the start ip of the storage network IP range + string + + + vlan + the ID or VID of the VLAN. + integer + + + zoneid + the Zone uuid of the storage network IP range + string + + + false + + + configureOvsElement + Configures an ovs element. + true + + + id + the ID of the ovs provider + true + uuid + + + enabled + Enabled/Disabled the service provider + true + boolean + + + + + id + the id of the ovs + string + + + account + the account associated with the provider + string + + + domain + the domain associated with the provider + string + + + domainid + the domain ID associated with the provider + string + + + domainpath + path of the domain to which the provider belongs + 4.19.2.0 + string + + + enabled + Enabled/Disabled the service provider + boolean + + + nspid + the physical network service provider id of the provider + string + + + project + the project name of the address + string + + + projectid + the project id of the ipaddress + string + + + false + + + listSystemVmsUsageHistory + Lists System VM stats + false + 4.18.0 + + + enddate + end date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + id + the ID of the system VM. + false + uuid + + + ids + the IDs of the system VMs, mutually exclusive with id. + false + list + list + + + keyword + List by keyword + false + string + + + name + name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs). + false + string + + + page + false + integer + + + pagesize + false + integer + + + startdate + start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss") + false + date + + + + + id + the ID of the virtual machine + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + name + the name of the virtual machine + string + + + stats + the list of VM stats + list + + + false + + + deleteIpv6FirewallRule + Deletes a IPv6 firewall rule + true + + + id + the ID of the IPv6 firewall rule + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVolume + Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it. + true + + + account + the account associated with the disk volume. Must be used with the domainId parameter. + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + string + + + diskofferingid + the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in. + false + uuid + + + displayvolume + an optional field, whether to display the volume to the end user or not. + false + boolean + + + domainid + the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain. + false + uuid + + + maxiops + max iops + false + long + + + miniops + min iops + false + long + + + name + the name of the disk volume + false + string + + + projectid + the project associated with the volume. Mutually exclusive with account parameter + false + uuid + + + size + Arbitrary volume size + false + long + + + snapshotid + the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in. + false + uuid + + + virtualmachineid + the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation + false + uuid + + + zoneid + the ID of the availability zone + false + uuid + + + + + id + ID of the disk volume + string + + + account + the account associated with the disk volume + string + + + attached + the date the volume was attached to a VM instance + date + + + chaininfo + the chain info of the volume + 4.4 + string + + + clusterid + cluster id of the volume + string + + + clustername + cluster name where the volume is allocated + string + + + created + the date the disk volume was created + date + + + deleteprotection + true if volume has delete protection. + 4.20.0 + boolean + + + destroyed + the boolean state of whether the volume is destroyed or not + boolean + + + deviceid + the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached. + long + + + diskBytesReadRate + bytes read rate of the disk volume + long + + + diskBytesWriteRate + bytes write rate of the disk volume + long + + + diskIopsReadRate + IO requests read rate of the disk volume per the disk offering + long + + + diskIopsWriteRate + IO requests write rate of the disk volume per the disk offering + long + + + diskioread + the read (IO) of disk on the vm + long + + + diskiowrite + the write (IO) of disk on the vm + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingdisplaytext + the display text of the disk offering + string + + + diskofferingid + ID of the disk offering + string + + + diskofferingname + name of the disk offering + string + + + displayvolume + an optional field whether to the display the volume to the end user or not. + boolean + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the Domain the disk volume belongs to + 4.19.2.0 + string + + + encryptformat + the format of the disk encryption if applicable + 4.19.1 + string + + + externaluuid + volume uuid that is given by virtualisation provider (only for VMware) + string + + + hypervisor + Hypervisor the volume belongs to + string + + + isextractable + true if the volume is extractable, false otherwise + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + maxiops + max iops of the disk volume + long + + + miniops + min iops of the disk volume + long + + + name + name of the disk volume + string + + + path + the path of the volume + string + + + physicalsize + the bytes actually consumed on disk + long + + + podid + pod id of the volume + string + + + podname + pod name of the volume + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + provisioningtype + provisioning type used to create volumes. + string + + + quiescevm + need quiesce vm or not when taking snapshot + 4.3 + boolean + + + serviceofferingdisplaytext + the display text of the service offering for root disk + string + + + serviceofferingid + ID of the service offering for root disk + string + + + serviceofferingname + name of the service offering for root disk + string + + + size + size of the disk volume + long + + + snapshotid + ID of the snapshot from which this volume was created + string + + + state + the state of the disk volume + string + + + status + the status of the volume + string + + + storage + name of the primary storage hosting the disk volume + string + + + storageid + id of the primary storage hosting the disk volume; returned to admin user only + 4.3 + string + + + storagetype + shared or local storage + string + + + supportsstoragesnapshot + true if storage snapshot is supported for the volume, false otherwise + 4.16 + boolean + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + type + type of the disk volume (ROOT or DATADISK) + string + + + utilization + the disk utilization + string + + + virtualmachineid + id of the virtual machine + string + + + virtualsize + the bytes allocated + long + + + vmdisplayname + display name of the virtual machine + string + + + vmname + name of the virtual machine + string + + + vmstate + state of the virtual machine + string + + + vmtype + type of the virtual machine + string + + + volumecheckresult + details for the volume check result, they may vary for different hypervisors + 4.19.1 + map + + + volumerepairresult + details for the volume repair result, they may vary for different hypervisors + 4.19.1 + map + + + zoneid + ID of the availability zone + string + + + zonename + name of the availability zone + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + createFirewallRule + Creates a firewall rule for a given IP address + true + + + ipaddressid + the IP address id of the port forwarding rule + true + uuid + + + protocol + the protocol for the firewall rule. Valid values are TCP/UDP/ICMP. + true + string + + + cidrlist + the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). + false + list + list + + + endport + the ending port of firewall rule + false + integer + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + icmpcode + error code for this icmp message + false + integer + + + icmptype + type of the ICMP message being sent + false + integer + + + startport + the starting port of firewall rule + false + integer + + + type + type of firewallrule: system/user + false + string + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listVMSnapshot + List virtual machine snapshot by conditions + false + 4.2.0 + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + lists snapshot by snapshot name or display name + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + state of the virtual machine snapshot + false + string + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + the ID of the vm + false + uuid + + + vmsnapshotid + The ID of the VM snapshot + false + uuid + + + vmsnapshotids + the IDs of the vm snapshots, mutually exclusive with vmsnapshotid + false + list + 4.9 + list + + + + + id + the ID of the vm snapshot + string + + + account + the account associated with the disk volume + string + + + created + the create date of the vm snapshot + date + + + current + indicates if this is current snapshot + boolean + + + description + the description of the vm snapshot + string + + + displayname + the display name of the vm snapshot + string + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the domain to which the disk volume belongs + 4.19.2.0 + string + + + hypervisor + the type of hypervisor on which snapshot is stored + string + + + name + the name of the vm snapshot + string + + + parent + the parent ID of the vm snapshot + string + + + parentName + the parent displayName of the vm snapshot + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the vm snapshot + state + + + type + VM Snapshot type + string + + + virtualmachineid + the vm ID of the vm snapshot + string + + + virtualmachinename + the vm name of the vm snapshot + 4.15.1 + string + + + zoneid + the Zone ID of the vm snapshot + string + + + zonename + the Zone name of the vm snapshot + 4.15.1 + string + + + false + + + moveNetworkAclItem + Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list + true + + + id + The ID of the network ACL rule that is being moved to a new position. + true + string + + + aclconsistencyhash + Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field). + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + nextaclruleid + The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list. + false + string + + + previousaclruleid + The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list. + false + string + + + + + id + the ID of the ACL Item + string + + + aclid + the ID of the ACL this item belongs to + string + + + aclname + the name of the ACL this item belongs to + string + + + action + Action of ACL Item. Allow/Deny + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of ACL's port range + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + number + Number of the ACL Item + integer + + + protocol + the protocol of the ACL + string + + + reason + an explanation on why this ACL rule is being applied + 4.12 + string + + + startport + the starting port of ACL's port range + string + + + state + the state of the rule + string + + + traffictype + the traffic type for the ACL + string + + + tags(*) + the list of resource tags associated with the network ACLs + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + disassociateIpAddress + Disassociates an IP address from the account. + true + + + id + the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter + false + uuid + + + ipaddress + IP Address to be disassociated. Mutually exclusive with the id parameter + false + 4.19.0 + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBaremetalDhcp + list baremetal dhcp servers + false + + + physicalnetworkid + the Physical Network ID + true + uuid + + + dhcpservertype + Type of DHCP device + false + string + + + id + DHCP server device ID + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + device id of + string + + + dhcpservertype + name of the provider + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + enableStorageMaintenance + Puts storage pool into maintenance state + true + + + id + Primary storage ID + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + removeSecondaryStorageSelector + Removes an existing secondary storage selector. + false + 4.19.0 + + + id + The unique identifier of the secondary storage selector to be removed. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listApis + lists all available apis on the server, provided by the Api Discovery plugin + false + 4.1.0 + + + name + API name + false + string + + + + + description + description of the api + string + + + isasync + true if api is asynchronous + boolean + + + name + the name of the api command + string + + + related + comma separated related apis + string + + + since + version of CloudStack the api was introduced in + string + + + type + response field type + string + + + params(*) + the list params the api accepts + + + description + description of the api parameter + string + + + length + length of the parameter + int + + + name + the name of the api parameter + string + + + related + comma separated related apis to get the parameter + string + + + required + true if this parameter is required for the api request + boolean + + + since + version of CloudStack the api was introduced in + string + + + type + parameter type + string + + + set + + + response(*) + api response fields + + + description + description of the api response field + string + + + name + the name of the api response field + string + + + response + api response fields + set + + + type + response field type + string + + + set + + + false + + + deleteBaremetalRct + deletes baremetal rack configuration text + true + + + id + RCT id + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + createVMSnapshot + Creates snapshot for a vm. + true + 4.2.0 + + + virtualmachineid + The ID of the vm + true + uuid + + + description + The description of the snapshot + false + string + + + name + The display name of the snapshot + false + string + + + quiescevm + quiesce vm if true + false + boolean + + + snapshotmemory + snapshot memory if true + false + boolean + + + + + id + the ID of the vm snapshot + string + + + account + the account associated with the disk volume + string + + + created + the create date of the vm snapshot + date + + + current + indicates if this is current snapshot + boolean + + + description + the description of the vm snapshot + string + + + displayname + the display name of the vm snapshot + string + + + domain + the domain associated with the disk volume + string + + + domainid + the ID of the domain associated with the disk volume + string + + + domainpath + path of the domain to which the disk volume belongs + 4.19.2.0 + string + + + hypervisor + the type of hypervisor on which snapshot is stored + string + + + name + the name of the vm snapshot + string + + + parent + the parent ID of the vm snapshot + string + + + parentName + the parent displayName of the vm snapshot + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the vm snapshot + state + + + type + VM Snapshot type + string + + + virtualmachineid + the vm ID of the vm snapshot + string + + + virtualmachinename + the vm name of the vm snapshot + 4.15.1 + string + + + zoneid + the Zone ID of the vm snapshot + string + + + zonename + the Zone name of the vm snapshot + 4.15.1 + string + + + false + + + deleteLoadBalancer + Deletes an internal load balancer + true + 4.2.0 + + + id + the ID of the Load Balancer + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listTungstenFabricTagType + Lists Tungsten-Fabric tags + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + tagtypeuuid + the uuid of Tungsten-Fabric tag type + false + string + + + zoneid + the ID of zone + false + uuid + + + + + name + Tungsten-Fabric tag type name + string + + + uuid + Tungsten-Fabric tag type uuid + string + + + zoneid + Tungsten-Fabric provider zone id + long + + + zonename + Tungsten-Fabric provider zone name + string + + + false + + + extractSnapshot + Returns a download URL for extracting a snapshot. It must be in the Backed Up state. + true + 4.20.0 + + + id + the ID of the snapshot + true + 4.20.0 + uuid + + + zoneid + the ID of the zone where the snapshot is located + true + 4.20.0 + uuid + + + + + id + the id of extracted object + string + + + accountid + the account id to which the extracted object belongs + string + + + created + the time and date the object was created + date + + + extractId + the upload id of extracted object + string + + + extractMode + the mode of extraction - upload or download + string + + + name + the name of the extracted object + string + + + state + the state of the extracted object + string + + + status + the status of the extraction + string + + + storagetype + type of the storage + string + + + uploadpercentage + the percentage of the entity uploaded to the specified location + integer + + + url + if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded + string + + + zoneid + zone ID the object was extracted from + string + + + zonename + zone name the object was extracted from + string + + + false + + + listSSHKeyPairs + List registered keypairs + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fingerprint + A public key fingerprint to look for + false + string + + + id + the ID of the ssh keypair + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + A key pair name to look for + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + + + id + ID of the ssh keypair + string + + + account + the owner of the keypair + string + + + domain + the domain name of the keypair owner + string + + + domainid + the domain id of the keypair owner + string + + + fingerprint + Fingerprint of the public key + string + + + name + Name of the keypair + string + + + project + the project name of the keypair owner + string + + + projectid + the project id of the keypair owner + string + + + false + + + cancelStorageMaintenance + Cancels maintenance for primary storage + true + + + id + the primary storage ID + true + uuid + + + + + id + the ID of the storage pool + string + + + allocatediops + total min IOPS currently in use by volumes + long + + + capacityiops + IOPS CloudStack can provision from this storage pool + long + + + clusterid + the ID of the cluster for the storage pool + string + + + clustername + the name of the cluster for the storage pool + string + + + created + the date and time the storage pool was created + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the storage pool + long + + + disksizeused + the host's currently used disk size + long + + + hypervisor + the hypervisor type of the storage pool + string + + + ipaddress + the IP address of the storage pool + string + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + managed + whether this pool is managed or not + boolean + + + name + the name of the storage pool + string + + + nfsmountopts + the nfs mount options for the storage pool + 4.19.1 + string + + + overprovisionfactor + the overprovisionfactor for the storage pool + 4.4 + string + + + path + the storage pool path + string + + + podid + the Pod ID of the storage pool + string + + + podname + the Pod name of the storage pool + string + + + provider + Storage provider for this pool + string + + + scope + the scope of the storage pool + string + + + state + the state of the storage pool + storagepoolstatus + + + storagecapabilities + the storage pool capabilities + map + + + storagecustomstats + the storage pool custom stats + 4.18.1 + map + + + suitableformigration + true if this pool is suitable to migrate a volume, false otherwise + boolean + + + tags + the tags for the storage pool + string + + + type + the storage pool type + string + + + zoneid + the Zone ID of the storage pool + string + + + zonename + the Zone name of the storage pool + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + quotaSummary + Lists balance and quota usage for all accounts + false + 4.7.0 + + + account + Optional, Account Id for which statement needs to be generated + false + string + + + domainid + Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain. + false + uuid + + + keyword + List by keyword + false + string + + + listall + Optional, to list all accounts irrespective of the quota activity + false + boolean + + + page + false + integer + + + pagesize + false + integer + + + + + account + account name + string + + + accountid + account id + string + + + balance + account balance + bigdecimal + + + currency + currency + string + + + domain + domain name + string + + + domainid + domain id + string + + + enddate + end date + date + + + quota + quota usage of this period + bigdecimal + + + quotaenabled + if the account has the quota config enabled + boolean + + + startdate + start date + date + + + state + account state + state + + + false + + + updateSnapshotPolicy + Updates the snapshot policy. + true + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the snapshot policy to the end user or not. + false + 4.4 + boolean + + + id + the ID of the snapshot policy + false + uuid + + + + + id + the ID of the snapshot policy + string + + + fordisplay + is this policy for display to the regular user + 4.4 + boolean + + + intervaltype + the interval type of the snapshot policy + short + + + maxsnaps + maximum number of snapshots retained + int + + + schedule + time the snapshot is scheduled to be taken. + string + + + timezone + the time zone of the snapshot policy + string + + + volumeid + the ID of the disk volume + string + + + zone + The list of zones in which snapshot backup is scheduled + 4.19.0 + set + + + false + + + queryAsyncJobResult + Retrieves the current status of asynchronous job. + false + + + jobid + the ID of the asynchronous job + true + uuid + + + + + account + the account that executed the async command + string + + + accountid + the account id that executed the async command + string + + + cmd + the async command executed + string + + + completed + the completed date of the job + date + + + created + the created date of the job + date + + + domainid + the domain id that executed the async command + string + + + domainpath + the domain that executed the async command + string + + + jobinstanceid + the unique ID of the instance/entity object related to the job + string + + + jobinstancetype + the instance/entity object related to the job + string + + + jobprocstatus + the progress information of the PENDING job + integer + + + jobresult + the result reason + responseobject + + + jobresultcode + the result code for the job + integer + + + jobresulttype + the result type + string + + + jobstatus + the current job status-should be 0 for PENDING + integer + + + managementserverid + the msid of the management server on which the job is running + 4.19 + long + + + userid + the user that executed the async command + string + + + jobid + the ID of the async job + + + false + + + registerNetscalerControlCenter + Adds a netscaler control center device + true + + + ipaddress + URL of the netscaler controlcenter appliance. + true + string + + + numretries + Credentials to reach netscaler controlcenter device + true + integer + + + password + Credentials to reach netscaler controlcenter device + true + string + + + username + Credentials to reach netscaler controlcenter device + true + string + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + createCounter + Adds metric counter for VM auto scaling + true + + + name + Name of the counter. + true + string + + + provider + Network provider of the counter. + true + 4.18.0 + string + + + source + Source of the counter. + true + string + + + value + Value of the counter e.g. oid in case of snmp. + true + string + + + + + id + the id of the Counter + string + + + name + Name of the counter. + string + + + provider + Provider of the counter. + string + + + source + Source of the counter. + string + + + value + Value in case of snmp or other specific counters. + string + + + zoneid + zone id of counter + string + + + false + + + listEventTypes + List Event Types + false + + + + name + Event Type + string + + + false + + + prepareForShutdown + Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted + false + 4.19.0 + + + managementserverid + the uuid of the management server + true + uuid + + + + + managementserverid + The id of the management server + long + + + pendingjobscount + The number of jobs in progress + long + + + readyforshutdown + Indicates whether CloudStack is ready to shutdown + boolean + + + shutdowntriggered + Indicates whether a shutdown has been triggered + boolean + + + false + + + addCluster + Adds a new cluster + false + + + clustername + the cluster name + true + string + + + clustertype + type of the cluster: CloudManaged, ExternalManaged + true + string + + + hypervisor + hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3 + true + string + + + podid + the Pod ID for the host + true + uuid + + + zoneid + the Zone ID for the cluster + true + uuid + + + allocationstate + Allocation state of this cluster for allocation of new resources + false + string + + + arch + the CPU arch of the cluster. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + guestvswitchname + Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting. + false + string + + + guestvswitchtype + Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch) + false + string + + + ovm3cluster + Ovm3 native OCFS2 clustering enabled for cluster + false + string + + + ovm3pool + Ovm3 native pooling enabled for cluster + false + string + + + ovm3vip + Ovm3 vip to use for pool (and cluster) + false + string + + + password + the password for the host + false + string + + + publicvswitchname + Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting. + false + string + + + publicvswitchtype + Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch) + false + string + + + url + the URL + false + string + + + username + the username for the cluster + false + string + + + vsmipaddress + the ipaddress of the VSM associated with this cluster + false + string + + + vsmpassword + the password for the VSM associated with this cluster + false + string + + + vsmusername + the username for the VSM associated with this cluster + false + string + + + + + id + the cluster ID + string + + + allocationstate + the allocation state of the cluster + string + + + arch + CPU Arch of the hosts in the cluster + 4.20 + string + + + clustertype + the type of the cluster + string + + + cpuovercommitratio + The cpu overcommit ratio of the cluster + string + + + hypervisortype + the hypervisor type of the cluster + string + + + managedstate + whether this cluster is managed by cloudstack + string + + + memoryovercommitratio + The memory overcommit ratio of the cluster + string + + + name + the cluster name + string + + + ovm3vip + Ovm3 VIP to use for pooling and/or clustering + string + + + podid + the Pod ID of the cluster + string + + + podname + the Pod name of the cluster + string + + + resourcedetails + Meta data associated with the zone (key/value pairs) + map + + + zoneid + the Zone ID of the cluster + string + + + zonename + the Zone name of the cluster + string + + + capacity(*) + the capacity of the Cluster + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + tag + The tag for the capacity type + 4.20.0 + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + false + + + removeNicFromVirtualMachine + Removes VM from specified network by deleting a NIC + true + + + nicid + NIC ID + true + uuid + + + virtualmachineid + Virtual Machine ID + true + uuid + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + deleteTrafficMonitor + Deletes an traffic monitor host. + false + + + id + Id of the Traffic Monitor Host. + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listDedicatedHosts + Lists dedicated hosts. + false + + + account + the name of the account associated with the host. Must be used with domainId. + false + string + + + affinitygroupid + list dedicated hosts by affinity group + false + uuid + + + domainid + the ID of the domain associated with the host + false + uuid + + + hostid + the ID of the host + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the dedicated resource + string + + + accountid + the Account ID of the host + string + + + affinitygroupid + the Dedication Affinity Group ID of the host + string + + + domainid + the domain ID of the host + string + + + hostid + the ID of the host + string + + + hostname + the name of the host + string + + + false + + + getDiagnosticsData + Get diagnostics and files from system VMs + true + 4.14.0.0 + + + targetid + The ID of the system VM instance to retrieve diagnostics data files from + true + uuid + + + files + A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided. + false + list + list + + + + + url + Storage URL to download retrieve diagnostics data files + string + + + false + + + getUploadParamsForIso + upload an existing ISO into the CloudStack cloud. + false + 4.13 + + + format + the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. + true + string + + + name + the name of the volume/template/iso + true + string + + + zoneid + the ID of the zone the volume/template/iso is to be hosted on + true + uuid + + + account + an optional accountName. Must be used with domainId. + false + string + + + bootable + true if this ISO is bootable. If not passed explicitly its assumed to be true + false + boolean + + + checksum + the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed + and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to + use another algorithm the hexadecimal string is to be prefixed with a string of the form, + "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string + representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not + contain an algorithm called SHA256 or one called sha-256, only SHA-256. + false + string + + + displaytext + the display text of the ISO. This is usually used for display purposes. + false + string + + + domainid + an optional domainId. If the account parameter is used, domainId must also be used. + false + uuid + + + isextractable + true if the ISO or its derivatives are extractable; default is false + false + boolean + + + isfeatured + true if you want this ISO to be featured + false + boolean + + + ispublic + true if you want to register the ISO to be publicly available to all users, false otherwise. + false + boolean + + + ostypeid + the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed + false + uuid + + + projectid + Upload volume/template/iso for the project + false + uuid + + + + + id + the template/volume ID + uuid + + + expires + the timestamp after which the signature expires + string + + + metadata + encrypted data to be sent in the POST request. + string + + + postURL + POST url to upload the file to + url + + + signature + signature to be sent in the POST request. + string + + + false + + + deleteAutoScaleVmGroup + Deletes a autoscale vm group. + true + + + id + the ID of the autoscale group + true + uuid + + + cleanup + true if all VMs have to be cleaned up, false otherwise + false + 4.18.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listPaloAltoFirewalls + lists Palo Alto firewall devices in a physical network + false + + + fwdeviceid + Palo Alto firewall device ID + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + physicalnetworkid + the Physical Network ID + false + uuid + + + + + fwdevicecapacity + device capacity + long + + + fwdeviceid + device id of the Palo Alto firewall + string + + + fwdevicename + device name + string + + + fwdevicestate + device state + string + + + ipaddress + the management IP address of the external firewall + string + + + numretries + the number of times to retry requests to the external firewall + string + + + physicalnetworkid + the physical network to which this Palo Alto firewall belongs to + string + + + privateinterface + the private interface of the external firewall + string + + + privatezone + the private security zone of the external firewall + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the external firewall + string + + + publiczone + the public security zone of the external firewall + string + + + timeout + the timeout (in seconds) for requests to the external firewall + string + + + usageinterface + the usage interface of the external firewall + string + + + username + the username that's used to log in to the external firewall + string + + + zoneid + the zone ID of the external firewall + string + + + false + + + updateLoadBalancerRule + Updates load balancer + true + + + id + the ID of the load balancer rule to update + true + uuid + + + algorithm + load balancer algorithm (source, roundrobin, leastconn) + false + string + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + description + the description of the load balancer rule + false + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + name + the name of the load balancer rule + false + string + + + protocol + The protocol for the LB + false + string + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + enableAccount + Enables an account + false + + + account + Enables specified account. + false + string + + + domainid + Enables specified account in this domain. + false + uuid + + + id + Account id + false + uuid + + + + + id + the id of the account + string + + + accountdetails + details for the account + map + + + accounttype + account type (admin, domain-admin, user) + integer + + + cpuavailable + the total number of cpu cores available to be created for this account + 4.2.0 + string + + + cpulimit + the total number of cpu cores the account can own + 4.2.0 + string + + + cputotal + the total number of cpu cores owned by account + 4.2.0 + long + + + created + the date when this account was created + date + + + defaultzoneid + the default zone of the account + string + + + domain + name of the Domain the account belongs to + string + + + domainid + id of the Domain the account belongs to + string + + + domainpath + path of the Domain the account belongs to + 4.13 + string + + + groups + the list of acl groups that account belongs to + 4.4 + list + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + ipavailable + the total number of public ip addresses available for this account to acquire + string + + + iplimit + the total number of public ip addresses this account can acquire + string + + + iptotal + the total number of public ip addresses allocated for this account + long + + + iscleanuprequired + true if the account requires cleanup + boolean + + + isdefault + true if account is default, false otherwise + 4.2.0 + boolean + + + memoryavailable + the total memory (in MB) available to be created for this account + 4.2.0 + string + + + memorylimit + the total memory (in MB) the account can own + 4.2.0 + string + + + memorytotal + the total memory (in MB) owned by account + 4.2.0 + long + + + name + the name of the account + string + + + networkavailable + the total number of networks available to be created for this account + 3.0.1 + string + + + networkdomain + the network domain + string + + + networklimit + the total number of networks the account can own + 3.0.1 + string + + + networktotal + the total number of networks owned by account + 3.0.1 + long + + + primarystorageavailable + the total primary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + primarystoragelimit + the total primary storage space (in GiB) the account can own + 4.2.0 + string + + + primarystoragetotal + the total primary storage space (in GiB) owned by account + 4.2.0 + long + + + projectavailable + the total number of projects available for administration by this account + 3.0.1 + string + + + projectlimit + the total number of projects the account can own + 3.0.1 + string + + + projecttotal + the total number of projects being administrated by this account + 3.0.1 + long + + + receivedbytes + the total number of network traffic bytes received + long + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role (Admin, ResourceAdmin, DomainAdmin, User) + string + + + secondarystorageavailable + the total secondary storage space (in GiB) available to be used for this account + 4.2.0 + string + + + secondarystoragelimit + the total secondary storage space (in GiB) the account can own + 4.2.0 + string + + + secondarystoragetotal + the total secondary storage space (in GiB) owned by account + 4.2.0 + float + + + sentbytes + the total number of network traffic bytes sent + long + + + snapshotavailable + the total number of snapshots available for this account + string + + + snapshotlimit + the total number of snapshots which can be stored by this account + string + + + snapshottotal + the total number of snapshots stored by this account + long + + + state + the state of the account + string + + + taggedresources + The tagged resource limit and count for the account + 4.20.0 + list + + + templateavailable + the total number of templates available to be created by this account + string + + + templatelimit + the total number of templates which can be created by this account + string + + + templatetotal + the total number of templates which have been created by this account + long + + + vmavailable + the total number of virtual machines available for this account to acquire + string + + + vmlimit + the total number of virtual machines that can be deployed by this account + string + + + vmrunning + the total number of virtual machines running for this account + integer + + + vmstopped + the total number of virtual machines stopped for this account + integer + + + vmtotal + the total number of virtual machines deployed by this account + long + + + volumeavailable + the total volume available for this account + string + + + volumelimit + the total volume which can be used by this account + string + + + volumetotal + the total volume being used by this account + long + + + vpcavailable + the total number of vpcs available to be created for this account + 4.0.0 + string + + + vpclimit + the total number of vpcs the account can own + 4.0.0 + string + + + vpctotal + the total number of vpcs owned by account + 4.0.0 + long + + + user(*) + the list of users associated with account + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + list + + + false + + + changeStoragePoolScope + Changes the scope of a storage pool when the pool is in Disabled state.This feature is officially tested and supported for Hypervisors: KVM and VMware, Protocols: NFS and Ceph, and Storage Provider: DefaultPrimary. There might be extra steps involved to make this work for other hypervisors and storage options. + true + 4.19.1 + + + id + the Id of the storage pool + true + uuid + + + scope + the scope of the storage: cluster or zone + true + string + + + clusterid + the Id of the cluster to use if scope is being set to Cluster + false + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteNetwork + Deletes a network + true + + + id + the ID of the network + true + uuid + + + forced + Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails. + false + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + reconnectHost + Reconnects a host. + true + + + id + the host ID + true + uuid + + + + + id + the ID of the host + string + + + annotation + the last annotation set on this host by an admin + 4.11 + string + + + arch + CPU Arch of the host + 4.20 + string + + + capabilities + capabilities of the host + string + + + clusterid + the cluster ID of the host + string + + + clustername + the cluster name of the host + string + + + clustertype + the cluster type of the cluster that host belongs to + string + + + cpuallocated + the amount of the host's CPU currently allocated + string + + + cpuallocatedpercentage + the amount of the host's CPU currently allocated in percentage + string + + + cpuallocatedvalue + the amount of the host's CPU currently allocated in MHz + long + + + cpuallocatedwithoverprovisioning + the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor + string + + + cpuloadaverage + the cpu average load on the host + double + + + cpunumber + the CPU number of the host + integer + + + cpusockets + the number of CPU sockets on the host + integer + + + cpuspeed + the CPU speed of the host + long + + + cpuused + the amount of the host's CPU currently used + string + + + cpuwithoverprovisioning + the amount of the host's CPU after applying the cpu.overprovisioning.factor + string + + + created + the date and time the host was created + date + + + details + Host details in key/value pairs. + 4.5 + map + + + disconnected + true if the host is disconnected. False otherwise. + date + + + disksizeallocated + the host's currently allocated disk size + long + + + disksizetotal + the total disk size of the host + long + + + encryptionsupported + true if the host supports encryption + 4.18 + boolean + + + events + events available for the host + string + + + explicithosttags + comma-separated list of explicit host tags for the host + 4.20.0 + string + + + hahost + true if the host is Ha host (dedicated to vms started by HA process; false otherwise + boolean + + + hasenoughcapacity + true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise + boolean + + + hostha + the host HA information information + hostharesponse + + + hosttags + comma-separated list of tags for the host + string + + + hypervisor + the host hypervisor + string + + + hypervisorversion + the hypervisor version + string + + + implicithosttags + comma-separated list of implicit host tags for the host + 4.20.0 + string + + + instanceconversionsupported + true if the host supports instance conversion (using virt-v2v) + 4.19.1 + boolean + + + ipaddress + the IP address of the host + string + + + islocalstorageactive + true if local storage is active, false otherwise + boolean + + + istagarule + Whether the informed tag is a JS interpretable rule or not. + boolean + + + lastannotated + the last time this host was annotated + 4.11 + date + + + lastpinged + the date and time the host was last pinged + date + + + managementserverid + the management server ID of the host + string + + + memoryallocated + the amount of the host's memory currently allocated + long + + + memoryallocatedbytes + the amount of the host's memory currently allocated in bytes + long + + + memoryallocatedpercentage + the amount of the host's memory currently allocated in percentage + string + + + memorytotal + the memory total of the host, this parameter is deprecated use memorywithoverprovisioning + long + + + memoryused + the amount of the host's memory currently used + long + + + memorywithoverprovisioning + the amount of the host's memory after applying the mem.overprovisioning.factor + string + + + name + the name of the host + string + + + networkkbsread + the incoming network traffic on the host + long + + + networkkbswrite + the outgoing network traffic on the host + long + + + oscategoryid + the OS category ID of the host + string + + + oscategoryname + the OS category name of the host + string + + + outofbandmanagement + the host out-of-band management information + outofbandmanagementresponse + + + podid + the Pod ID of the host + string + + + podname + the Pod name of the host + string + + + removed + the date and time the host was removed + date + + + resourcestate + the resource state of the host + string + + + state + the state of the host + status + + + suitableformigration + 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 + boolean + + + type + the host type + type + + + ueficapability + true if the host has capability to support UEFI boot + boolean + + + username + the admin that annotated this host + 4.11 + string + + + version + the host version + string + + + zoneid + the Zone ID of the host + string + + + zonename + the Zone name of the host + string + + + gpugroup(*) + GPU cards present in the host + 4.4 + + + gpugroupname + GPU cards present in the host + string + + + vgpu(*) + the list of enabled vGPUs + + + maxcapacity + Maximum vgpu can be created with this vgpu type on the given gpu group + long + + + maxheads + Maximum displays per user + long + + + maxresolutionx + Maximum X resolution per display + long + + + maxresolutiony + Maximum Y resolution per display + long + + + maxvgpuperpgpu + Maximum no. of vgpu per gpu card (pgpu) + long + + + remainingcapacity + Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type + long + + + vgputype + Model Name of vGPU + string + + + videoram + Video RAM for this vGPU type + long + + + list + + + list + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + startKubernetesCluster + Starts a stopped CloudManaged Kubernetes cluster + true + + + id + the ID of the Kubernetes cluster + true + uuid + + + + + id + the id of the Kubernetes cluster + string + + + account + the account associated with the Kubernetes cluster + string + + + associatednetworkname + the name of the network of the Kubernetes cluster + string + + + autoscalingenabled + Whether autoscaling is enabled for the cluster + boolean + + + clustertype + the type of the cluster + clustertype + + + consoleendpoint + URL end point for the Kubernetes cluster dashboard UI + string + + + controlnodes + the control nodes count for the Kubernetes cluster + long + + + cpunumber + the cpu cores of the Kubernetes cluster + string + + + created + the date when this Kubernetes cluster was created + date + + + description + the description of the Kubernetes cluster + string + + + domain + the name of the domain in which the Kubernetes cluster exists + string + + + domainid + the ID of the domain in which the Kubernetes cluster exists + string + + + domainpath + path of the domain to which the Kubernetes cluster belongs + 4.19.2.0 + string + + + endpoint + URL end point for the Kubernetes cluster + string + + + ipaddress + Public IP Address of the cluster + string + + + ipaddressid + Public IP Address ID of the cluster + string + + + keypair + keypair details + string + + + kubernetesversionid + the ID of the Kubernetes version for the Kubernetes cluster + string + + + kubernetesversionname + the name of the Kubernetes version for the Kubernetes cluster + string + + + masternodes + the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. + long + + + maxsize + Maximum size of the cluster + long + + + memory + the memory the Kubernetes cluster + string + + + minsize + Minimum size of the cluster + long + + + name + the name of the Kubernetes cluster + string + + + networkid + the ID of the network of the Kubernetes cluster + string + + + project + the project name of the Kubernetes cluster + string + + + projectid + the project id of the Kubernetes cluster + string + + + serviceofferingid + the ID of the service offering of the Kubernetes cluster + string + + + serviceofferingname + the name of the service offering of the Kubernetes cluster + string + + + size + the size (worker nodes count) of the Kubernetes cluster + long + + + state + the state of the Kubernetes cluster + string + + + templateid + the ID of the template of the Kubernetes cluster + string + + + virtualmachines + the list of virtualmachine associated with this Kubernetes cluster + list + + + zoneid + the name of the zone of the Kubernetes cluster + string + + + zonename + the name of the zone of the Kubernetes cluster + string + + + false + + + deleteProject + Deletes a project + true + 3.0.0 + + + id + id of the project to be deleted + true + uuid + + + cleanup + true if all project resources have to be cleaned up, false otherwise + false + 4.16.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listSharedFileSystemProviders + Lists all available shared filesystem providers. + false + 4.20.0 + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + name + the name of the shared filesystem provider + string + + + false + + + addNetscalerLoadBalancer + Adds a netscaler load balancer device + true + + + networkdevicetype + Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer + true + string + + + password + Credentials to reach netscaler load balancer device + true + string + + + physicalnetworkid + the Physical Network ID + true + uuid + + + url + URL of the netscaler load balancer appliance. + true + string + + + username + Credentials to reach netscaler load balancer device + true + string + + + gslbprovider + true if NetScaler device being added is for providing GSLB service + false + boolean + + + gslbproviderprivateip + private IP of the site + false + string + + + gslbproviderpublicip + public IP of the site + false + string + + + isexclusivegslbprovider + true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB + false + boolean + + + + + gslbprovider + true if NetScaler device is provisioned to be a GSLB service provider + boolean + + + gslbproviderprivateip + private IP of the NetScaler representing GSLB site + string + + + gslbproviderpublicip + public IP of the NetScaler representing GSLB site + string + + + ipaddress + the management IP address of the external load balancer + string + + + isexclusivegslbprovider + true if NetScaler device is provisioned exclusively to be a GSLB service provider + boolean + + + lbdevicecapacity + device capacity + long + + + lbdevicededicated + true if device is dedicated for an account + boolean + + + lbdeviceid + device id of the netscaler load balancer + string + + + lbdevicename + device name + string + + + lbdevicestate + device state + string + + + physicalnetworkid + the physical network to which this netscaler device belongs to + string + + + podids + Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. + list + + + privateinterface + the private interface of the load balancer + string + + + provider + name of the provider + string + + + publicinterface + the public interface of the load balancer + string + + + false + + + listIsoPermissions + List iso visibility and all accounts that have permissions to view this iso. + false + + + id + the template ID + true + uuid + + + + + id + the template ID + string + + + account + the list of accounts the template is available for + list + + + domainid + the ID of the domain to which the template belongs + string + + + ispublic + true if this template is a public template, false otherwise + boolean + + + projectids + the list of projects the template is available for + list + + + false + + + listBackupSchedule + List backup schedule of a VM + false + 4.14.0 + + + virtualmachineid + ID of the VM + true + uuid + + + + + intervaltype + the interval type of the backup schedule + intervaltype + + + schedule + time the backup is scheduled to be taken. + string + + + timezone + the time zone of the backup schedule + string + + + virtualmachineid + ID of the VM + string + + + virtualmachinename + name of the VM + string + + + false + + + restoreVolumeFromBackupAndAttachToVM + Restore and attach a backed up volume to VM + true + 4.14.0 + + + backupid + ID of the VM backup + true + uuid + + + virtualmachineid + id of the VM where to attach the restored volume + true + uuid + + + volumeid + ID of the volume backed up + true + string + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + removeNetworkPermissions + Removes network permissions. + false + 4.17.0 + + + networkid + the network ID + true + uuid + + + accountids + a comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + accounts + a comma delimited list of accounts within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + projectids + a comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in. + false + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + configTungstenFabricService + config Tungsten-Fabric service + false + + + physicalnetworkid + the ID of physical network + true + uuid + + + zoneid + the ID of zone + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listBaremetalPxeServers + list baremetal pxe server + false + + + physicalnetworkid + the Physical Network ID + true + uuid + + + id + Pxe server device ID + false + long + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + device id of + string + + + physicalnetworkid + the physical network to which this external dhcp device belongs to + string + + + provider + name of the provider + string + + + url + url + string + + + false + + + listLoadBalancerRules + Lists load balancer rules. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + domainid + list only resources belonging to the domain specified + false + uuid + + + fordisplay + list resources by display flag; only ROOT admin is eligible to pass this parameter + false + 4.4 + boolean + + + id + the ID of the load balancer rule + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + name + the name of the load balancer rule + false + string + + + networkid + list by network ID the rule belongs to + false + uuid + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + publicipid + the public IP address ID of the load balancer rule + false + uuid + + + tags + List resources by tags (key/value pairs) + false + map + map + + + virtualmachineid + the ID of the virtual machine of the load balancer rule + false + uuid + + + zoneid + the availability zone ID + false + uuid + + + + + id + the load balancer rule ID + string + + + account + the account of the load balancer rule + string + + + algorithm + the load balancer algorithm (source, roundrobin, leastconn) + string + + + cidrlist + the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). + string + + + description + the description of the load balancer + string + + + domain + the domain of the load balancer rule + string + + + domainid + the domain ID of the load balancer rule + string + + + domainpath + path of the domain to which the load balancer rule belongs + 4.19.2.0 + string + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + name + the name of the load balancer + string + + + networkid + the id of the guest network the lb rule belongs to + string + + + privateport + the private port + string + + + project + the project name of the load balancer + string + + + projectid + the project id of the load balancer + string + + + protocol + the protocol of the loadbalanacer rule + string + + + publicip + the public ip address + string + + + publicipid + the public ip address id + string + + + publicport + the public port + string + + + state + the state of the rule + string + + + zoneid + the id of the zone the rule belongs to + string + + + zonename + the name of the zone the load balancer rule belongs to + 4.11 + string + + + tags(*) + the list of resource tags associated with load balancer + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + getUser + Find user account by API key + false + + + userapikey + API key of the user + true + string + + + + + id + the user ID + string + + + account + the account name of the user + string + + + accountid + the account ID of the user + string + + + accounttype + the account type of the user + integer + + + apikey + the api key of the user + string + + + created + the date and time the user account was created + date + + + domain + the domain name of the user + string + + + domainid + the domain ID of the user + string + + + email + the user email address + string + + + firstname + the user firstname + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + is2faenabled + true if user has two factor authentication enabled + 4.18.0.0 + boolean + + + is2famandated + true if user has two factor authentication is mandated + 4.18.0.0 + boolean + + + iscallerchilddomain + the boolean value representing if the updating target is in caller's child domain + boolean + + + isdefault + true if user is default, false otherwise + 4.2.0 + boolean + + + lastname + the user lastname + string + + + roleid + the ID of the role + string + + + rolename + the name of the role + string + + + roletype + the type of the role + string + + + secretkey + the secret key of the user + string + + + state + the user state + string + + + timezone + the timezone user was created in + string + + + username + the user name + string + + + usersource + the source type of the user in lowercase, such as native, ldap, saml2 + string + + + false + + + createManagementNetworkIpRange + Creates a Management network IP range. + true + 4.11.0.0 + + + gateway + The gateway for the management network. + true + string + + + netmask + The netmask for the management network. + true + string + + + podid + UUID of POD, where the IP range belongs to. + true + uuid + + + startip + The starting IP address. + true + string + + + endip + The ending IP address. + false + string + + + forsystemvms + Specify if range is dedicated for CPVM and SSVM. + false + boolean + + + vlan + Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan + false + string + + + + + id + the ID of the Pod + string + + + allocationstate + the allocation state of the Pod + string + + + endip + the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter. + list + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter. + list + + + gateway + the gateway of the Pod + string + + + name + the name of the Pod + string + + + netmask + the netmask of the Pod + string + + + startip + the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter. + list + + + vlanid + indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter. + list + + + zoneid + the Zone ID of the Pod + string + + + zonename + the Zone name of the Pod + string + + + capacity(*) + the capacity of the Pod + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + tag + The tag for the capacity type + 4.20.0 + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + list + + + ipranges(*) + the IP ranges for the Pod + 4.16.0 + + + cidr + the CIDR for the range + string + + + endip + the ending IP for the range + string + + + forsystemvms + indicates if range is dedicated for CPVM and SSVM + string + + + gateway + the gateway for the range + string + + + startip + the starting IP for the range + string + + + vlanid + indicates Vlan ID for the range + string + + + list + + + false + + + listCiscoNexusVSMs + Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster + false + + + clusterid + Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance. + false + uuid + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + zoneid + Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance. + false + uuid + + + + + ipaddress + the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module + string + + + vsmconfigmode + The mode of the VSM (standalone/HA) + string + + + vsmconfigstate + The Config State (Primary/Standby) of the VSM + string + + + vsmctrlvlanid + control vlan id of the VSM + int + + + vsmdeviceid + device id of the Cisco N1KV VSM device + string + + + vsmdevicename + device name + string + + + vsmdevicestate + device state + string + + + vsmdevicestate + The Device State (Enabled/Disabled) of the VSM + string + + + vsmdomainid + The VSM is a switch supervisor. This is the VSM's switch domain id + string + + + vsmmgmtvlanid + management vlan id of the VSM + string + + + vsmpktvlanid + packet vlan id of the VSM + int + + + vsmstoragevlanid + storage vlan id of the VSM + int + + + false + + + addVpnUser + Adds vpn users + true + + + password + password for the username + true + string + + + username + username for the vpn user + true + string + + + account + an optional account for the vpn user. Must be used with domainId. + false + string + + + domainid + an optional domainId for the vpn user. If the account parameter is used, domainId must also be used. + false + uuid + + + projectid + add vpn user to the specific project + false + uuid + + + + + id + the vpn userID + string + + + account + the account of the remote access vpn + string + + + domain + the domain name of the account of the remote access vpn + string + + + domainid + the domain id of the account of the remote access vpn + string + + + domainpath + path of the domain to which the remote access vpn belongs + 4.19.2.0 + string + + + project + the project name of the vpn + string + + + projectid + the project id of the vpn + string + + + state + the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'. + string + + + username + the username of the vpn user + string + + + false + + + deleteBackup + Delete VM backup + true + 4.14.0 + + + id + id of the VM backup + true + uuid + + + forced + force the deletion of backup which removes the entire backup chain but keep VM in Backup Offering + false + 4.18.0.0 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + deleteProjectRolePermission + Deletes a project role permission in the project + false + 4.15.0 + + + id + ID of the project role permission to be deleted + true + uuid + + + projectid + ID of the project where the project role permission is to be deleted + true + uuid + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateQuarantinedIp + Updates the quarantine end date for the given public IP address. + false + 4.19 + + + enddate + The date when the quarantine will no longer be active. + true + date + + + id + The ID of the public IP address in active quarantine. + false + uuid + + + ipaddress + The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine. + false + string + + + + + id + ID of the quarantine process. + string + + + created + When the quarantine was created. + date + + + enddate + End date for the quarantine. + date + + + ipaddress + The public IP address in quarantine. + string + + + previousownerid + Account ID of the previous public IP address owner. + string + + + previousownername + Account name of the previous public IP address owner. + string + + + removalreason + The reason for removing the IP from quarantine prematurely. + string + + + removed + When the quarantine was removed. + date + + + removeraccountid + ID of the account that removed the IP from quarantine. + string + + + false + + + updateVnfTemplate + Updates a template to VNF template or attributes of a VNF template. + false + 4.19.0 + + + id + the ID of the image file + true + uuid + + + arch + the CPU arch of the template/ISO. Valid options are: x86_64, aarch64 + false + 4.20 + string + + + bootable + true if image is bootable, false otherwise; available only for updateIso API + false + boolean + + + cleanupdetails + optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action) + false + boolean + + + cleanupvnfdetails + optional boolean field, which indicates if VNF details will be cleaned up or not + false + boolean + + + cleanupvnfnics + optional boolean field, which indicates if VNF nics will be cleaned up or not + false + boolean + + + details + Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 + false + map + map + + + displaytext + the display text of the image + false + string + + + format + the format for the image + false + string + + + isdynamicallyscalable + true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + false + boolean + + + isrouting + true if the template type is routing i.e., if template is used to deploy router + false + boolean + + + name + the name of the image file + false + string + + + ostypeid + the ID of the OS type that best represents the OS of this image. + false + uuid + + + passwordenabled + true if the image supports the password reset feature; default is false + false + boolean + + + requireshvm + true if the template requires HVM, false otherwise; available only for updateTemplate API + false + boolean + + + sortkey + sort key of the template, integer + false + integer + + + sshkeyenabled + true if the template supports the sshkey upload feature; default is false + false + boolean + + + templatetag + the tag for this template. + false + 4.20.0 + string + + + templatetype + the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). + false + string + + + vnfdetails + VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0 + false + map + map + + + vnfnics + VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC + false + map + map + + + + + id + the template ID + string + + + account + the account name to which the template belongs + string + + + accountid + the account id to which the template belongs + string + + + arch + CPU Arch of the template + 4.20 + string + + + bits + the processor bit size + 4.10 + int + + + bootable + true if the ISO is bootable, false otherwise + boolean + + + checksum + checksum of the template + string + + + childtemplates + if root disk template, then ids of the datas disk templates this template owns + set + + + created + the date this template was created + date + + + crossZones + true if the template is managed across all Zones, false otherwise + boolean + + + deployasis + VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. + 4.15 + boolean + + + deployasisdetails + VMware only: additional key/value details tied with deploy-as-is template + 4.15 + map + + + details + additional key/value details tied with template + map + + + directdownload + KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage + boolean + + + displaytext + the template display text + string + + + domain + the name of the domain to which the template belongs + string + + + domainid + the ID of the domain to which the template belongs + string + + + domainpath + path of the Domain the template belongs to + 4.19.2.0 + string + + + downloaddetails + Lists the download progress of a template across all secondary storages + list + + + format + the format of the template. + imageformat + + + hostid + the ID of the secondary storage host for the template + string + + + hostname + the name of the secondary storage host for the template + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0.0 + resourceiconresponse + + + isdynamicallyscalable + true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory + boolean + + + isextractable + true if the template is extractable, false otherwise + boolean + + + isfeatured + true if this template is a featured template, false otherwise + boolean + + + ispublic + true if this template is a public template, false otherwise + boolean + + + isready + true if the template is ready to be deployed from, false otherwise. + boolean + + + name + the template name + string + + + ostypeid + the ID of the OS type for this template. + string + + + ostypename + the name of the OS type for this template. + string + + + parenttemplateid + if Datadisk template, then id of the root disk template this template belongs to + string + + + passwordenabled + true if the reset password feature is enabled, false otherwise + boolean + + + physicalsize + the physical size of the template + long + + + project + the project name of the template + string + + + projectid + the project id of the template + string + + + removed + the date this template was removed + date + + + requireshvm + true if template requires HVM enabled, false otherwise + boolean + + + size + the size of the template + long + + + sourcetemplateid + the template ID of the parent template if present + string + + + sshkeyenabled + true if template is sshkey enabled, false otherwise + boolean + + + status + the status of the template + string + + + templatetag + the tag of this template + string + + + templatetype + the type of the template + string + + + url + the URL which the template/iso is registered from + string + + + userdataid + the id of userdata linked to this template + 4.18.0 + string + + + userdataname + the name of userdata linked to this template + 4.18.0 + string + + + userdataparams + list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + zoneid + the ID of the zone for this template + string + + + zonename + the name of the zone for this template + string + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateVPCOffering + Updates VPC offering + true + + + id + the id of the VPC offering + true + uuid + + + displaytext + the display text of the VPC offering + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + name + the name of the VPC offering + false + string + + + sortkey + sort key of the VPC offering, integer + false + integer + + + state + update state for the VPC offering; supported states - Enabled/Disabled + false + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the vpc offering + string + + + created + the date this vpc offering was created + date + + + displaytext + an alternate display text of the vpc offering. + string + + + distributedvpcrouter + indicates if the vpc offering supports distributed router for one-hop forwarding + 4.4 + boolean + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + fornsx + true if vpc offering can be used by NSX networks only + boolean + + + internetprotocol + the internet protocol of the vpc offering + string + + + isdefault + true if vpc offering is default, false otherwise + boolean + + + name + the name of the vpc offering + string + + + networkmode + Mode in which the network will operate. The valid values are NATTED and ROUTED + string + + + routingmode + the routing mode for the network offering, supported types are Static or Dynamic. + string + + + specifyasnumber + true if network offering supports choosing AS numbers + boolean + + + state + state of the vpc offering. Can be Disabled/Enabled + string + + + supportsregionLevelvpc + indicated if the offering can support region level vpc + 4.4 + boolean + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + service(*) + the list of supported services + + + name + the service name + string + + + capability(*) + the list of capabilities + + + canchooseservicecapability + can this service capability value can be choosable while creatine network offerings + boolean + + + name + the capability name + string + + + value + the capability value + string + + + list + + + provider(*) + the service provider name + + + id + uuid of the network provider + string + + + canenableindividualservice + true if individual services can be enabled/disabled + boolean + + + destinationphysicalnetworkid + the destination physical network + string + + + name + the provider name + string + + + physicalnetworkid + the physical network this belongs to + string + + + servicelist + services for this provider + list + + + state + state of the network provider + string + + + list + + + list + + + false + + + listSamlAuthorization + Lists authorized users who can used SAML SSO + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + userid + User uuid + false + uuid + + + + + idpid + the authorized Identity Provider ID + string + + + status + the SAML authorization status + boolean + + + userid + the user ID + string + + + false + + + listUserTwoFactorAuthenticatorProviders + Lists user two factor authenticator providers + false + 4.18.0 + + + name + List user two factor authenticator provider by name + false + string + + + + + description + the description of the user two factor authenticator provider + string + + + name + the user two factor authenticator provider name + string + + + false + + + scaleVirtualMachine + Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume. + true + + + id + The ID of the virtual machine + true + uuid + + + serviceofferingid + the ID of the service offering for the virtual machine + true + uuid + + + automigrate + Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering + false + 4.17 + boolean + + + details + name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value + false + map + map + + + maxiops + New maximum number of IOPS for the custom disk offering + false + 4.17 + long + + + miniops + New minimum number of IOPS for the custom disk offering + false + 4.17 + long + + + shrinkok + Verify OK to Shrink + false + 4.17 + boolean + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + updateEgressFirewallRule + Updates egress firewall rule + true + 4.4 + + + id + the ID of the egress firewall rule + true + uuid + + + customid + an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only + false + 4.4 + string + + + fordisplay + an optional field, whether to the display the rule to the end user or not + false + 4.4 + boolean + + + + + id + the ID of the firewall rule + string + + + cidrlist + the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). + string + + + destcidrlist + the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). + string + + + endport + the ending port of firewall rule's port range + integer + + + fordisplay + is rule for display to the regular user + 4.4 + boolean + + + icmpcode + error code for this icmp message + integer + + + icmptype + type of the icmp message being sent + integer + + + ipaddress + the public ip address for the firewall rule + string + + + ipaddressid + the public ip address id for the firewall rule + string + + + networkid + the network id of the firewall rule + string + + + protocol + the protocol of the firewall rule + string + + + startport + the starting port of firewall rule's port range + integer + + + state + the state of the rule + string + + + traffictype + the traffic type for the firewall rule + 4.17.0 + string + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + list + + + false + + + listOsCategories + Lists all supported OS categories for this cloud. + false + + + id + list Os category by id + false + uuid + + + keyword + List by keyword + false + string + + + name + list os category by name + false + 3.0.1 + string + + + page + false + integer + + + pagesize + false + integer + + + + + id + the ID of the OS category + string + + + name + the name of the OS category + string + + + false + + + listServiceOfferings + Lists all available service offerings. + false + + + account + list resources by account. Must be used with the domainId parameter. + false + string + + + cpunumber + the CPU number that listed offerings must support + false + 4.15 + integer + + + cpuspeed + the CPU speed that listed offerings must support + false + 4.15 + integer + + + domainid + list only resources belonging to the domain specified + false + uuid + + + encryptroot + listed offerings support root disk encryption + false + 4.18 + boolean + + + id + ID of the service offering + false + uuid + + + isrecursive + defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. + false + boolean + + + issystem + is this a system vm offering + false + boolean + + + keyword + List by keyword + false + string + + + listall + If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. + false + boolean + + + memory + the RAM memory that listed offering must support + false + 4.15 + integer + + + name + name of the service offering + false + string + + + page + false + integer + + + pagesize + false + integer + + + projectid + list objects by project; if projectid=-1 lists All VMs + false + uuid + + + state + Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings. + false + 4.19 + string + + + storagetype + the storage type of the service offering. Values are local and shared. + false + 4.19 + string + + + systemvmtype + the system VM type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter". + false + string + + + templateid + The ID of the template that listed offerings must support + false + 4.20.0 + uuid + + + virtualmachineid + the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to. + false + uuid + + + zoneid + id of zone disk offering is associated with + false + 4.13 + uuid + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + purgeresources + Whether to cleanup VM and its associated resource upon expunge + 4.20 + boolean + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + state + state of the service offering + string + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + importVm + Import virtual machine from a unmanaged host into CloudStack + true + 4.19.0 + + + clusterid + the cluster ID + true + uuid + + + hypervisor + hypervisor type of the host + true + string + + + importsource + Source location for Import + true + string + + + name + the name of the instance as it is known to the hypervisor + true + string + + + serviceofferingid + the service offering for the virtual machine + true + uuid + + + zoneid + the zone ID + true + uuid + + + account + an optional account for the virtual machine. Must be used with domainId. + false + string + + + clustername + (only for importing VMs from VMware to KVM) Name of VMware cluster. + false + string + + + convertinstancehostid + (only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v migration from VMware to KVM. + false + uuid + + + convertinstancepoolid + (only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM. + false + uuid + + + datacentername + (only for importing VMs from VMware to KVM) Name of VMware datacenter. + false + string + + + datadiskofferinglist + datadisk template to disk-offering mapping using keys disk and diskOffering + false + map + map + + + details + used to specify the custom parameters. + false + map + map + + + diskpath + path of the disk image + false + string + + + displayname + the display name of the instance + false + string + + + domainid + import instance to the domain specified + false + uuid + + + existingvcenterid + (only for importing VMs from VMware to KVM) UUID of a linked existing vCenter + false + uuid + + + forced + VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated + false + boolean + + + forcemstoimportvmfiles + (only for importing VMs from VMware to KVM) optional - if true, forces MS to import VM file(s) to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not. + false + boolean + + + host + the host name or IP address + false + string + + + hostid + Host where local disk is located + false + uuid + + + hostip + (only for importing VMs from VMware to KVM) VMware ESXi host IP/Name. + false + string + + + hostname + the host name of the instance + false + string + + + migrateallowed + vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool + false + boolean + + + networkid + the network ID + false + uuid + + + nicipaddresslist + VM nic to ip address mapping using keys nic, ip4Address + false + map + map + + + nicnetworklist + VM nic to network id mapping using keys nic and network + false + map + map + + + password + the password for the host + false + string + + + projectid + import instance for the project + false + uuid + + + storageid + Shared storage pool where disk is located + false + uuid + + + templateid + the ID of the template for the virtual machine + false + uuid + + + temppath + Temp Path on external host for disk image copy + false + string + + + username + the username for the host + false + string + + + vcenter + (only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server. + false + string + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + listAffinityGroupTypes + Lists affinity group types available + false + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + + + type + the type of the affinity group + string + + + false + + + removeFromGlobalLoadBalancerRule + Removes a load balancer rule association with global load balancer rule + true + + + id + The ID of the load balancer rule + true + uuid + + + loadbalancerrulelist + the list load balancer rules that will be assigned to global load balancer rule + true + list + list + + + + + displaytext + any text associated with the success or failure + string + + + success + true if operation is executed successfully + boolean + + + false + + + listCapacity + Lists all the system wide capacities. + false + + + clusterid + lists capacity by the Cluster ID + false + 3.0.0 + uuid + + + fetchlatest + recalculate capacities and fetch the latest + false + 3.0.0 + boolean + + + keyword + List by keyword + false + string + + + page + false + integer + + + pagesize + false + integer + + + podid + lists capacity by the Pod ID + false + uuid + + + sortby + Sort the results. Available values: Usage + false + 3.0.0 + string + + + tag + Tag for the resource type + false + 4.20.0 + string + + + type + lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90. + false + integer + + + zoneid + lists capacity by the Zone ID + false + uuid + + + + + capacityallocated + the capacity currently in allocated + long + + + capacitytotal + the total capacity available + long + + + capacityused + the capacity currently in use + long + + + clusterid + the Cluster ID + string + + + clustername + the Cluster name + string + + + name + the capacity name + string + + + percentused + the percentage of capacity currently in use + string + + + podid + the Pod ID + string + + + podname + the Pod name + string + + + tag + The tag for the capacity type + 4.20.0 + string + + + type + the capacity type + short + + + zoneid + the Zone ID + string + + + zonename + the Zone name + string + + + false + + + stopVirtualMachine + Stops a virtual machine. + true + + + id + The ID of the virtual machine + true + uuid + + + forced + Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the VM is stopped and should be marked as such. + false + boolean + + + + + id + the ID of the virtual machine + string + + + account + the account associated with the virtual machine + string + + + autoscalevmgroupid + ID of AutoScale VM group + 4.18.0 + string + + + autoscalevmgroupname + Name of AutoScale VM group + 4.18.0 + string + + + backupofferingid + the ID of the backup offering of the virtual machine + 4.14 + string + + + backupofferingname + the name of the backup offering of the virtual machine + 4.14 + string + + + bootmode + Guest vm Boot Mode + string + + + boottype + Guest vm Boot Type + string + + + cpunumber + the number of vCPUs this virtual machine is using + integer + + + cpuspeed + the speed of each vCPU + integer + + + cpuused + the amount of the vm's CPU currently used + string + + + created + the date when this virtual machine was created + date + + + deleteprotection + true if vm has delete protection. + 4.20.0 + boolean + + + details + Vm details in key/value pairs. + 4.2.1 + map + + + diskioread + the read (IO) of disk on the VM + long + + + diskiowrite + the write (IO) of disk on the VM + long + + + diskkbsread + the VM's disk read in KiB + long + + + diskkbswrite + the VM's disk write in KiB + long + + + diskofferingid + the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + diskofferingname + the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead + 4.4 + string + + + displayname + user generated name. The name of the virtual machine is returned if no displayname exists. + string + + + displayvm + an optional field whether to the display the vm to the end user or not. + boolean + + + domain + the name of the domain in which the virtual machine exists + string + + + domainid + the ID of the domain in which the virtual machine exists + string + + + domainpath + path of the domain in which the virtual machine exists + 4.19.2.0 + string + + + forvirtualnetwork + the virtual network for the service offering + boolean + + + group + the group name of the virtual machine + string + + + groupid + the group ID of the virtual machine + string + + + guestosid + Os type ID of the virtual machine + string + + + haenable + true if high-availability is enabled, false otherwise + boolean + + + hostcontrolstate + the control state of the host for the virtual machine + string + + + hostid + the ID of the host for the virtual machine + string + + + hostname + the name of the host for the virtual machine + string + + + hypervisor + the hypervisor on which the template runs + string + + + icon + Base64 string representation of the resource icon + 4.16.0 + resourceiconresponse + + + instancename + instance name of the user vm; this parameter is returned to the ROOT admin only + 3.0.1 + string + + + ipaddress + the VM's primary IP address + string + + + isdynamicallyscalable + true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. + boolean + + + isodisplaytext + an alternate display text of the ISO attached to the virtual machine + string + + + isoid + the ID of the ISO attached to the virtual machine + string + + + isoname + the name of the ISO attached to the virtual machine + string + + + keypairs + ssh key-pairs + string + + + lastupdated + the date when this virtual machine was updated last time + 4.16.0 + date + + + memory + the memory allocated for the virtual machine + integer + + + memoryintfreekbs + the internal memory (KiB) that's free in VM or zero if it can not be calculated + long + + + memorykbs + the memory used by the VM in KiB + long + + + memorytargetkbs + the target memory in VM (KiB) + long + + + name + the name of the virtual machine + string + + + networkkbsread + the incoming network traffic on the VM in KiB + long + + + networkkbswrite + the outgoing network traffic on the host in KiB + long + + + osdisplayname + OS name of the vm + 4.13.2 + string + + + ostypeid + OS type id of the vm + 4.4 + string + + + password + the password (if exists) of the virtual machine + string + + + passwordenabled + true if the password rest feature is enabled, false otherwise + boolean + + + pooltype + the pool type of the virtual machine + 4.16 + string + + + project + the project name of the vm + string + + + projectid + the project id of the vm + string + + + publicip + public IP address id associated with vm via Static nat rule + string + + + publicipid + public IP address id associated with vm via Static nat rule + string + + + readonlydetails + List of read-only Vm details as comma separated string. + 4.16.0 + string + + + receivedbytes + the total number of network traffic bytes received + long + + + rootdeviceid + device ID of the root volume + long + + + rootdevicetype + device type of the root volume + string + + + sentbytes + the total number of network traffic bytes sent + long + + + serviceofferingid + the ID of the service offering of the virtual machine + string + + + serviceofferingname + the name of the service offering of the virtual machine + string + + + servicestate + State of the Service from LB rule + string + + + state + the state of the virtual machine + string + + + templatedisplaytext + an alternate display text of the template for the virtual machine + string + + + templateformat + the format of the template for the virtual machine + 4.19.1 + string + + + templateid + the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. + string + + + templatename + the name of the template for the virtual machine + string + + + templatetype + the type of the template for the virtual machine + 4.19.0 + string + + + userdata + Base64 string containing the user data + 4.18.0.0 + string + + + userdatadetails + list of variables and values for the variables declared in userdata + 4.18.0 + string + + + userdataid + the id of userdata used for the VM + 4.18.0 + string + + + userdataname + the name of userdata used for the VM + 4.18.0 + string + + + userdatapolicy + the userdata override policy with the userdata provided while deploying VM + 4.18.0 + string + + + userid + the user's ID who deployed the virtual machine + string + + + username + the user's name who deployed the virtual machine + string + + + vgpu + the vGPU type used by the virtual machine + 4.4 + string + + + vmtype + User VM type + 4.20.0 + string + + + vnfdetails + VNF details + 4.19.0 + map + + + vnfnics + NICs of the VNF appliance + 4.19.0 + list + + + zoneid + the ID of the availability zone for the virtual machine + string + + + zonename + the name of the availability zone for the virtual machine + string + + + affinitygroup(*) + list of affinity groups associated with the virtual machine + + + id + the ID of the affinity group + string + + + account + the account owning the affinity group + string + + + dedicatedresources + dedicated resources associated with this affinity group + list + + + description + the description of the affinity group + string + + + domain + the domain name of the affinity group + string + + + domainid + the domain ID of the affinity group + string + + + domainpath + path of the Domain the affinity group belongs to + 4.19.2.0 + string + + + name + the name of the affinity group + string + + + project + the project name of the affinity group + string + + + projectid + the project ID of the affinity group + string + + + type + the type of the affinity group + string + + + virtualmachineIds + virtual machine IDs associated with this affinity group + list + + + set + + + nic(*) + the list of nics associated with vm + + + id + the ID of the nic + string + + + adaptertype + Type of adapter if available + 4.14.0 + string + + + broadcasturi + the broadcast uri of the nic + string + + + deviceid + device id for the network when plugged into the virtual machine + 4.4 + string + + + extradhcpoption + the extra dhcp options on the nic + 4.11.0 + list + + + gateway + the gateway of the nic + string + + + ip6address + the IPv6 address of network + string + + + ip6cidr + the cidr of IPv6 network + string + + + ip6gateway + the gateway of IPv6 network + string + + + ipaddress + the ip address of the nic + string + + + ipaddresses + IP addresses associated with NIC found for unmanaged VM + 4.14.0 + list + + + isdefault + true if nic is default, false otherwise + boolean + + + isolatedpvlan + the isolated private VLAN if available + 4.14.0 + integer + + + isolatedpvlantype + the isolated private VLAN type if available + 4.14.0 + string + + + isolationuri + the isolation uri of the nic + string + + + macaddress + true if nic is default, false otherwise + string + + + mtu + MTU configured on the NIC + 4.18.0 + integer + + + netmask + the netmask of the nic + string + + + networkid + the ID of the corresponding network + string + + + networkname + the name of the corresponding network + string + + + nsxlogicalswitch + Id of the NSX Logical Switch (if NSX based), null otherwise + 4.6.0 + string + + + nsxlogicalswitchport + Id of the NSX Logical Switch Port (if NSX based), null otherwise + 4.6.0 + string + + + publicip + public IP address associated with this nic via Static nat rule + string + + + publicipid + public IP address id associated with this nic via Static nat rule + string + + + secondaryip + the Secondary ipv4 addr of nic + list + + + traffictype + the traffic type of the nic + string + + + type + the type of the nic + string + + + virtualmachineid + Id of the vm to which the nic belongs + string + + + vlanid + ID of the VLAN/VNI if available + 4.14.0 + integer + + + vpcid + Id of the vpc to which the nic belongs + string + + + vpcname + name of the vpc to which the nic belongs + string + + + set + + + securitygroup(*) + list of security groups associated with the virtual machine + + + id + the ID of the security group + string + + + account + the account owning the security group + string + + + description + the description of the security group + string + + + domain + the domain name of the security group + string + + + domainid + the domain ID of the security group + string + + + domainpath + path of the Domain the security group belongs to + 4.19.2.0 + string + + + name + the name of the security group + string + + + project + the project name of the group + string + + + projectid + the project id of the group + string + + + virtualmachinecount + the number of virtualmachines associated with this securitygroup + 4.6.0 + integer + + + virtualmachineids + the list of virtualmachine ids associated with this securitygroup + 4.6.0 + set + + + egressrule(*) + the list of egress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + ingressrule(*) + the list of ingress rules associated with the security group + + + account + account owning the security group rule + string + + + cidr + the CIDR notation for the base IP address of the security group rule + string + + + endport + the ending IP of the security group rule + integer + + + icmpcode + the code for the ICMP message response + integer + + + icmptype + the type of the ICMP message response + integer + + + protocol + the protocol of the security group rule + string + + + ruleid + the id of the security group rule + string + + + securitygroupname + security group name + string + + + startport + the starting IP of the security group rule + integer + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + set + + + tags(*) + the list of resource tags associated with the rule + + + account + the account associated with the tag + string + + + customer + customer associated with the tag + string + + + domain + the domain associated with the tag + string + + + domainid + the ID of the domain associated with the tag + string + + + domainpath + path of the Domain associated with the tag + 4.19.2.0 + string + + + key + tag key name + string + + + project + the project name where tag belongs to + string + + + projectid + the project id the tag belongs to + string + + + resourceid + id of the resource + string + + + resourcetype + resource type + string + + + value + tag value + string + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + set + + + jobid + the ID of the latest async job acting on this object + + + jobstatus + the current status of the latest async job acting on this object + + + false + + + updateServiceOffering + Updates a service offering. + false + + + id + the ID of the service offering to be updated + true + uuid + + + displaytext + the display text of the service offering to be updated + false + string + + + domainid + the ID of the containing domain(s) as comma separated string, public for public offerings + false + string + + + hosttags + the host tag for this service offering. + false + 4.16 + string + + + name + the name of the service offering to be updated + false + string + + + purgeresources + Whether to cleanup VM and its associated resource upon expunge + false + 4.20 + boolean + + + sortkey + sort key of the service offering, integer + false + integer + + + state + state of the service offering + false + string + + + storagetags + comma-separated list of tags for the service offering, tags should match with existing storage pool tags + false + 4.16 + string + + + zoneid + the ID of the containing zone(s) as comma separated string, all for all zones offerings + false + 4.13 + string + + + + + id + the id of the service offering + string + + + cacheMode + the cache mode to use for this disk offering. none, writeback or writethrough + 4.14 + string + + + cpunumber + the number of CPU + integer + + + cpuspeed + the clock rate CPU speed in Mhz + integer + + + created + the date this service offering was created + date + + + defaultuse + is this a default system vm offering + boolean + + + deploymentplanner + deployment strategy used to deploy VM. + string + + + diskBytesReadRate + bytes read rate of the service offering + long + + + diskBytesReadRateMax + burst bytes read rate of the disk offering + long + + + diskBytesReadRateMaxLength + length (in seconds) of the burst + long + + + diskBytesWriteRate + bytes write rate of the service offering + long + + + diskBytesWriteRateMax + burst bytes write rate of the disk offering + long + + + diskBytesWriteRateMaxLength + length (in seconds) of the burst + long + + + diskIopsReadRate + io requests read rate of the service offering + long + + + diskIopsReadRateMax + burst io requests read rate of the disk offering + long + + + diskIopsReadRateMaxLength + length (in second) of the burst + long + + + diskIopsWriteRate + io requests write rate of the service offering + long + + + diskIopsWriteRateMax + burst io requests write rate of the disk offering + long + + + diskIopsWriteRateMaxLength + length (in seconds) of the burst + long + + + diskofferingdisplaytext + the display text of the disk offering + 4.17 + string + + + diskofferingid + the ID of the disk offering to which service offering is linked + 4.17 + string + + + diskofferingname + name of the disk offering + 4.17 + string + + + diskofferingstrictness + True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed + 4.17 + boolean + + + displaytext + an alternate display text of the service offering. + string + + + domain + the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + domainid + the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + string + + + dynamicscalingenabled + true if virtual machine needs to be dynamically scalable of cpu or memory + 4.16 + boolean + + + encryptroot + true if virtual machine root disk will be encrypted on storage + 4.18 + boolean + + + hosttags + the host tag for the service offering + string + + + hypervisorsnapshotreserve + Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) + 4.4 + integer + + + iscustomized + is true if the offering is customized + 4.3.0 + boolean + + + iscustomizediops + true if disk offering uses custom iops, false otherwise + 4.4 + boolean + + + issystem + is this a system vm offering + boolean + + + isvolatile + true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk + boolean + + + limitcpuuse + restrict the CPU usage to committed service offering + boolean + + + maxiops + the max iops of the disk offering + 4.4 + long + + + memory + the memory in MB + integer + + + miniops + the min iops of the disk offering + 4.4 + long + + + name + the name of the service offering + string + + + networkrate + data transfer rate in megabits per second allowed. + integer + + + offerha + the ha support in the service offering + boolean + + + provisioningtype + provisioning type used to create volumes. Valid values are thin, sparse, fat. + 4.4.0 + string + + + purgeresources + Whether to cleanup VM and its associated resource upon expunge + 4.20 + boolean + + + rootdisksize + Root disk size in GB + 4.15 + long + + + serviceofferingdetails + additional key/value details tied with this service offering + 4.2.0 + map + + + state + state of the service offering + string + + + storagetags + the tags for the service offering + string + + + storagetype + the storage type for this service offering + string + + + systemvmtype + is this a the systemvm type for system vm offering + string + + + vspherestoragepolicy + the vsphere storage policy tagged to the service offering in case of VMware + 4.15 + string + + + zone + the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + zoneid + the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. + 4.13.0 + string + + + false + + + createNetworkACLList + Creates a network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone. + true + + + name + Name of the network ACL list + true + string + + + description + Description of the network ACL list + false + string + + + fordisplay + an optional field, whether to the display the list to the end user or not + false + 4.4 + boolean + + + vpcid + ID of the VPC associated with this network ACL list + false + uuid + + + + + id + the ID of the ACL + string + + + description + Description of the ACL + string + + + fordisplay + is ACL for display to the regular user + 4.4 + boolean + + + name + the Name of the ACL + string + + + vpcid + Id of the VPC this ACL is associated with + string + + + vpcname + Name of the VPC this ACL is associated with + string + + + false + + \ No newline at end of file diff --git a/README.md b/README.md index c156bfa..feb4454 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Build API doc ```bash $ cd /path/to/cloudstack $ git fetch -$ git checkout master +$ git checkout main $ git checkout $ mvn -Pdeveloper -Dnoredist clean install -DskipTests=true $ mvn -Pdeveloper -Dnoredist clean install -pl :cloud-apidoc diff --git a/diff-417-418/diff.json b/diff-417-418/diff.json new file mode 100644 index 0000000..0b652b9 --- /dev/null +++ b/diff-417-418/diff.json @@ -0,0 +1 @@ +{"commands_args_changed":[{"request":{"params_changed":[{"required_new":false,"required_old":true,"name":"startip"},{"required_new":false,"required_old":true,"name":"netmask"},{"required_new":false,"required_old":true,"name":"gateway"}]},"name":"createPod"},{"response":{"params_new":[{"name":"userdataid"},{"name":"userdataname"},{"name":"userdataparams"},{"name":"userdatapolicy"}]},"name":"copyIso"},{"request":{"params_new":[{"name":"autoscalevmgroupid","required":false},{"name":"clusterid","required":false},{"name":"hostid","required":false},{"name":"podid","required":false},{"name":"storageid","required":false},{"name":"userdata","required":false}]},"name":"listVirtualMachinesMetrics"},{"response":{"params_new":[{"name":"encryptionsupported"}]},"name":"listHosts"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"rebootSystemVm"},{"response":{"params_new":[{"name":"ip6dns1"},{"name":"ip6dns2"},{"name":"privatemtu"},{"name":"publicmtu"},{"name":"supportsvmautoscaling"},{"name":"tungstenvirtualrouteruuid"}]},"name":"listNetworks"},{"response":{"params_new":[{"name":"project"},{"name":"projectid"}]},"name":"registerSSHKeyPair"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"restoreVirtualMachine"},{"response":{"params_new":[{"name":"encryptionsupported"}]},"name":"updateHost"},{"request":{"params_new":[{"name":"domainid","required":false}]},"name":"listVPCOfferings"},{"response":{"params_new":[{"name":"vmtype"}]},"name":"uploadVolume"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"destroySystemVm"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"scaleSystemVm"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"stopRouter"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"changeServiceForVirtualMachine"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"startRouter"},{"response":{"params_new":[{"name":"userdataid"},{"name":"userdataname"},{"name":"userdataparams"},{"name":"userdatapolicy"}]},"name":"listTemplates"},{"response":{"params_new":[{"name":"component"},{"name":"defaultvalue"},{"name":"displaytext"},{"name":"group"},{"name":"options"},{"name":"parent"},{"name":"subgroup"},{"name":"type"}]},"name":"resetConfiguration"},{"request":{"params_new":[{"name":"name","required":false}]},"response":{"params_new":[{"name":"name"}]},"name":"createAutoScalePolicy"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"rebootVirtualMachine"},{"response":{"params_new":[{"name":"fortungsten"}]},"name":"updateNetworkOffering"},{"request":{"params_new":[{"name":"publicmtu","required":false}]},"response":{"params_new":[{"name":"dns1"},{"name":"dns2"},{"name":"ip6dns1"},{"name":"ip6dns2"},{"name":"publicmtu"}]},"name":"updateVPC"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"stopSystemVm"},{"request":{"params_new":[{"name":"fortungsten","required":false}]},"response":{"params_new":[{"name":"fortungsten"}]},"name":"createNetworkOffering"},{"request":{"params_new":[{"name":"listsystemvms","required":false}]},"name":"listVolumesMetrics"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"updateVmNicIp"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"startInternalLoadBalancerVM"},{"response":{"params_new":[{"name":"details"},{"name":"encrypt"}]},"name":"updateDiskOffering"},{"request":{"params_new":[{"name":"enddate","required":false},{"name":"listall","required":false},{"name":"name","required":false}]},"response":{"params_new":[{"name":"activationRule"},{"name":"endDate"},{"name":"name"},{"name":"removed"},{"name":"usageTypeDescription"},{"name":"uuid"}]},"name":"quotaTariffList"},{"response":{"params_new":[{"name":"created"}]},"name":"listKubernetesClusters"},{"request":{"params_new":[{"name":"name","required":false}]},"response":{"params_new":[{"name":"associatednetworkid"},{"name":"associatednetworkname"},{"name":"availablevirtualmachinecount"},{"name":"created"},{"name":"lbprovider"},{"name":"name"},{"name":"privateport"},{"name":"publicip"},{"name":"publicipid"},{"name":"publicport"}]},"name":"createAutoScaleVmGroup"},{"request":{"params_new":[{"name":"group","required":false},{"name":"parent","required":false},{"name":"subgroup","required":false}]},"response":{"params_new":[{"name":"component"},{"name":"defaultvalue"},{"name":"displaytext"},{"name":"group"},{"name":"options"},{"name":"parent"},{"name":"subgroup"},{"name":"type"}]},"name":"listConfigurations"},{"request":{"params_new":[{"name":"name","required":true},{"name":"activationrule","required":false},{"name":"description","required":false},{"name":"enddate","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"usagetype"},{"required_new":false,"required_old":true,"name":"startdate"},{"required_new":false,"required_old":true,"name":"value"}]},"response":{"params_new":[{"name":"activationRule"},{"name":"endDate"},{"name":"name"},{"name":"removed"},{"name":"usageTypeDescription"},{"name":"uuid"}]},"name":"quotaTariffUpdate"},{"response":{"params_new":[{"name":"created"}]},"name":"scaleKubernetesCluster"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"stopNetScalerVpx"},{"response":{"params_new":[{"name":"instancesdisksstatsretentionenabled"},{"name":"instancesdisksstatsretentiontime"},{"name":"instancesstatsretentiontime"},{"name":"instancesstatsuseronly"}]},"name":"listCapabilities"},{"request":{"params_new":[{"name":"projectid","required":false}]},"response":{"params_new":[{"name":"counterid"},{"name":"countername"}]},"name":"listConditions"},{"response":{"params_new":[{"name":"vmtype"}]},"name":"destroyVolume"},{"response":{"params_new":[{"name":"associatednetworkid"},{"name":"associatednetworkname"},{"name":"availablevirtualmachinecount"},{"name":"created"},{"name":"lbprovider"},{"name":"name"},{"name":"privateport"},{"name":"publicip"},{"name":"publicipid"},{"name":"publicport"}]},"name":"disableAutoScaleVmGroup"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"listSystemVms"},{"response":{"params_new":[{"name":"vmtype"}]},"name":"detachVolume"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"changeServiceForSystemVm"},{"response":{"params_new":[{"name":"mtu"},{"name":"vpcid"},{"name":"vpcname"}]},"name":"listNics"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"rebootRouter"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"addNicToVirtualMachine"},{"response":{"params_new":[{"name":"userdataid"},{"name":"userdataname"},{"name":"userdataparams"},{"name":"userdatapolicy"}]},"name":"updateIso"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"updateDefaultNicForVirtualMachine"},{"response":{"params_new":[{"name":"userdataid"},{"name":"userdataname"},{"name":"userdataparams"},{"name":"userdatapolicy"}]},"name":"prepareTemplate"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"stopInternalLoadBalancerVM"},{"response":{"params_new":[{"name":"is2faenabled"},{"name":"is2faverified"},{"name":"issuerfor2fa"},{"name":"providerfor2fa"}]},"name":"samlSso"},{"response":{"params_new":[{"name":"is2faenabled"},{"name":"is2faverified"},{"name":"issuerfor2fa"},{"name":"providerfor2fa"}]},"name":"login"},{"response":{"params_new":[{"name":"userdataid"},{"name":"userdataname"},{"name":"userdataparams"},{"name":"userdatapolicy"}]},"name":"copyTemplate"},{"request":{"params_new":[{"name":"encryptroot","required":false}]},"response":{"params_new":[{"name":"encryptroot"}]},"name":"createServiceOffering"},{"response":{"params_new":[{"name":"ip6dns1"},{"name":"ip6dns2"},{"name":"privatemtu"},{"name":"publicmtu"},{"name":"supportsvmautoscaling"},{"name":"tungstenvirtualrouteruuid"}]},"name":"listNiciraNvpDeviceNetworks"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"assignVirtualMachine"},{"response":{"params_new":[{"name":"vmtype"}]},"name":"resizeVolume"},{"response":{"params_new":[{"name":"userdataid"},{"name":"userdataname"},{"name":"userdataparams"},{"name":"userdatapolicy"}]},"name":"updateTemplate"},{"response":{"params_new":[{"name":"ip6dns1"},{"name":"ip6dns2"},{"name":"privatemtu"},{"name":"publicmtu"},{"name":"supportsvmautoscaling"},{"name":"tungstenvirtualrouteruuid"}]},"name":"listPaloAltoFirewallNetworks"},{"response":{"params_new":[{"name":"vmtype"}]},"name":"changeOfferingForVolume"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"changeServiceForRouter"},{"response":{"params_new":[{"name":"vmtype"}]},"name":"updateVolume"},{"request":{"params_new":[{"name":"userdatadetails","required":false},{"name":"userdataid","required":false}]},"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"updateVirtualMachine"},{"request":{"params_new":[{"name":"dns1","required":false},{"name":"dns2","required":false},{"name":"ip6dns1","required":false},{"name":"ip6dns2","required":false},{"name":"privatemtu","required":false},{"name":"publicmtu","required":false}]},"response":{"params_new":[{"name":"ip6dns1"},{"name":"ip6dns2"},{"name":"privatemtu"},{"name":"publicmtu"},{"name":"supportsvmautoscaling"},{"name":"tungstenvirtualrouteruuid"}]},"name":"updateNetwork"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"migrateVirtualMachine"},{"response":{"params_new":[{"name":"userdataid"},{"name":"userdataname"},{"name":"userdataparams"},{"name":"userdatapolicy"}]},"name":"createTemplate"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"resetPasswordForVirtualMachine"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"resetSSHKeyForVirtualMachine"},{"response":{"params_new":[{"name":"created"}]},"name":"addKubernetesSupportedVersion"},{"request":{"params_new":[{"name":"dns1","required":false},{"name":"dns2","required":false},{"name":"ip6dns1","required":false},{"name":"ip6dns2","required":false},{"name":"publicmtu","required":false}]},"response":{"params_new":[{"name":"dns1"},{"name":"dns2"},{"name":"ip6dns1"},{"name":"ip6dns2"},{"name":"publicmtu"}]},"name":"createVPC"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"listInternalLoadBalancerVMs"},{"response":{"params_new":[{"name":"created"}]},"name":"updateKubernetesSupportedVersion"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"detachIso"},{"response":{"params_new":[{"name":"encryptionsupported"}]},"name":"prepareHostForMaintenance"},{"request":{"params_new":[{"name":"name","required":false}]},"response":{"params_new":[{"name":"associatednetworkid"},{"name":"associatednetworkname"},{"name":"availablevirtualmachinecount"},{"name":"created"},{"name":"lbprovider"},{"name":"name"},{"name":"privateport"},{"name":"publicip"},{"name":"publicipid"},{"name":"publicport"}]},"name":"updateAutoScaleVmGroup"},{"request":{"params_removed":[{"name":"destroyvmgraceperiod"}],"params_new":[{"name":"expungevmgraceperiod","required":false},{"name":"otherdeployparams","required":false},{"name":"serviceofferingid","required":false},{"name":"userdata","required":false}]},"response":{"params_removed":[{"name":"destroyvmgraceperiod"}],"params_new":[{"name":"expungevmgraceperiod"},{"name":"userdata"}]},"name":"updateAutoScaleVmProfile"},{"response":{"params_new":[{"name":"associatednetworkid"},{"name":"associatednetworkname"},{"name":"availablevirtualmachinecount"},{"name":"created"},{"name":"lbprovider"},{"name":"name"},{"name":"privateport"},{"name":"publicip"},{"name":"publicipid"},{"name":"publicport"}]},"name":"enableAutoScaleVmGroup"},{"request":{"params_new":[{"name":"autoscalevmgroupid","required":false},{"name":"userdata","required":false}]},"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"listVirtualMachines"},{"request":{"params_new":[{"name":"encrypt","required":false}]},"response":{"params_new":[{"name":"details"},{"name":"encrypt"}]},"name":"listDiskOfferings"},{"response":{"params_new":[{"name":"created"}]},"name":"upgradeKubernetesCluster"},{"request":{"params_new":[{"name":"projectid","required":false}]},"response":{"params_new":[{"name":"counterid"},{"name":"countername"}]},"name":"createCondition"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"revertToVMSnapshot"},{"response":{"params_new":[{"name":"userdataid"},{"name":"userdataname"},{"name":"userdataparams"},{"name":"userdatapolicy"}]},"name":"registerIso"},{"request":{"params_new":[{"name":"iodriverpolicy","required":false},{"name":"iothreadsenabled","required":false},{"name":"userdatadetails","required":false},{"name":"userdataid","required":false}]},"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"deployVirtualMachine"},{"response":{"params_new":[{"name":"allowuserspecifyvrmtu"},{"name":"routerprivateinterfacemaxmtu"},{"name":"routerpublicinterfacemaxmtu"},{"name":"type"}]},"name":"updateZone"},{"response":{"params_new":[{"name":"encryptionsupported"}]},"name":"cancelHostMaintenance"},{"request":{"params_new":[{"name":"name","required":false}]},"response":{"params_new":[{"name":"name"}]},"name":"updateAutoScalePolicy"},{"request":{"params_new":[{"name":"encrypt","required":false}]},"response":{"params_new":[{"name":"details"},{"name":"encrypt"}]},"name":"createDiskOffering"},{"request":{"params_new":[{"name":"listsystemvms","required":false}]},"response":{"params_new":[{"name":"vmtype"}]},"name":"listVolumes"},{"response":{"params_new":[{"name":"is2faenabled"},{"name":"is2famandated"}]},"name":"lockUser"},{"request":{"params_new":[{"name":"dns1","required":false},{"name":"dns2","required":false},{"name":"ip6dns1","required":false},{"name":"ip6dns2","required":false},{"name":"privatemtu","required":false},{"name":"publicmtu","required":false},{"name":"tungstenvirtualrouteruuid","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"displaytext"}]},"response":{"params_new":[{"name":"ip6dns1"},{"name":"ip6dns2"},{"name":"privatemtu"},{"name":"publicmtu"},{"name":"supportsvmautoscaling"},{"name":"tungstenvirtualrouteruuid"}]},"name":"createNetwork"},{"response":{"params_new":[{"name":"fortungsten"}]},"name":"listNetworkOfferings"},{"response":{"params_new":[{"name":"dns1"},{"name":"dns2"},{"name":"ip6dns1"},{"name":"ip6dns2"},{"name":"publicmtu"}]},"name":"listVPCs"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"migrateVirtualMachineWithVolume"},{"request":{"params_new":[{"name":"mandate2fa","required":false}]},"response":{"params_new":[{"name":"is2faenabled"},{"name":"is2famandated"}]},"name":"updateUser"},{"response":{"params_new":[{"name":"vmtype"}]},"name":"attachVolume"},{"response":{"params_new":[{"name":"encryptionsupported"}]},"name":"addHost"},{"response":{"params_new":[{"name":"is2faenabled"},{"name":"is2famandated"}]},"name":"listUsers"},{"response":{"params_new":[{"name":"is2faenabled"},{"name":"is2famandated"}]},"name":"disableUser"},{"response":{"params_new":[{"name":"userdataid"},{"name":"userdataname"},{"name":"userdataparams"},{"name":"userdatapolicy"}]},"name":"listIsos"},{"request":{"params_new":[{"name":"name","required":false},{"name":"projectid","required":false}]},"response":{"params_new":[{"name":"name"}]},"name":"listAutoScalePolicies"},{"response":{"params_new":[{"name":"allowuserspecifyvrmtu"},{"name":"routerprivateinterfacemaxmtu"},{"name":"routerpublicinterfacemaxmtu"},{"name":"type"}]},"name":"listZones"},{"response":{"params_new":[{"name":"ip6dns1"},{"name":"ip6dns2"},{"name":"privatemtu"},{"name":"publicmtu"},{"name":"supportsvmautoscaling"},{"name":"tungstenvirtualrouteruuid"}]},"name":"listNetscalerLoadBalancerNetworks"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"startSystemVm"},{"response":{"params_new":[{"name":"created"}]},"name":"createKubernetesCluster"},{"response":{"params_new":[{"name":"encryptionsupported"}]},"name":"declareHostAsDegraded"},{"response":{"params_new":[{"name":"vmtype"}]},"name":"migrateVolume"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"updateVMAffinityGroup"},{"response":{"params_new":[{"name":"dns1"},{"name":"dns2"},{"name":"ip6dns1"},{"name":"ip6dns2"},{"name":"publicmtu"}]},"name":"migrateVPC"},{"response":{"params_new":[{"name":"component"},{"name":"defaultvalue"},{"name":"displaytext"},{"name":"group"},{"name":"options"},{"name":"parent"},{"name":"subgroup"},{"name":"type"}]},"name":"updateConfiguration"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"recoverVirtualMachine"},{"request":{"params_new":[{"name":"provider","required":false}]},"response":{"params_new":[{"name":"provider"}]},"name":"listCounters"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"migrateSystemVm"},{"response":{"params_removed":[{"name":"destroyvmgraceperiod"}],"params_new":[{"name":"expungevmgraceperiod"},{"name":"userdata"}]},"name":"listAutoScaleVmProfiles"},{"response":{"params_new":[{"name":"encryptionsupported"}]},"name":"cancelHostAsDegraded"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"listRouters"},{"response":{"params_new":[{"name":"ip6dns1"},{"name":"ip6dns2"},{"name":"privatemtu"},{"name":"publicmtu"},{"name":"supportsvmautoscaling"},{"name":"tungstenvirtualrouteruuid"}]},"name":"listBrocadeVcsDeviceNetworks"},{"response":{"params_new":[{"name":"created"}]},"name":"listKubernetesSupportedVersions"},{"response":{"params_new":[{"name":"vmtype"}]},"name":"recoverVolume"},{"response":{"params_new":[{"name":"is2faenabled"},{"name":"is2famandated"}]},"name":"enableUser"},{"response":{"params_new":[{"name":"ip6dns1"},{"name":"ip6dns2"},{"name":"privatemtu"},{"name":"publicmtu"},{"name":"supportsvmautoscaling"},{"name":"tungstenvirtualrouteruuid"}]},"name":"migrateNetwork"},{"response":{"params_new":[{"name":"userdataid"},{"name":"userdataname"},{"name":"userdataparams"},{"name":"userdatapolicy"}]},"name":"registerTemplate"},{"request":{"params_new":[{"name":"isedge","required":false}]},"response":{"params_new":[{"name":"allowuserspecifyvrmtu"},{"name":"routerprivateinterfacemaxmtu"},{"name":"routerpublicinterfacemaxmtu"},{"name":"type"}]},"name":"createZone"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"importUnmanagedInstance"},{"request":{"params_new":[{"name":"name","required":false}]},"response":{"params_new":[{"name":"associatednetworkid"},{"name":"associatednetworkname"},{"name":"availablevirtualmachinecount"},{"name":"created"},{"name":"lbprovider"},{"name":"name"},{"name":"privateport"},{"name":"publicip"},{"name":"publicipid"},{"name":"publicport"}]},"name":"listAutoScaleVmGroups"},{"response":{"params_new":[{"name":"vmtype"}]},"name":"createVolume"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"attachIso"},{"response":{"params_new":[{"name":"is2faenabled"},{"name":"is2famandated"}]},"name":"createUser"},{"response":{"params_new":[{"name":"project"},{"name":"projectid"}]},"name":"listSSHKeyPairs"},{"response":{"params_new":[{"name":"hostcontrolstate"}]},"name":"destroyRouter"},{"response":{"params_new":[{"name":"quotaenabled"}]},"name":"quotaSummary"},{"request":{"params_new":[{"name":"provider","required":true}]},"response":{"params_new":[{"name":"provider"}]},"name":"createCounter"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"removeNicFromVirtualMachine"},{"request":{"params_new":[{"name":"cleanup","required":false}]},"name":"deleteAutoScaleVmGroup"},{"request":{"params_removed":[{"name":"destroyvmgraceperiod"}],"params_new":[{"name":"account","required":false},{"name":"domainid","required":false},{"name":"expungevmgraceperiod","required":false},{"name":"projectid","required":false},{"name":"userdata","required":false}]},"response":{"params_removed":[{"name":"destroyvmgraceperiod"}],"params_new":[{"name":"expungevmgraceperiod"},{"name":"userdata"}]},"name":"createAutoScaleVmProfile"},{"response":{"params_new":[{"name":"encryptionsupported"}]},"name":"reconnectHost"},{"response":{"params_new":[{"name":"created"}]},"name":"startKubernetesCluster"},{"response":{"params_new":[{"name":"is2faenabled"},{"name":"is2famandated"}]},"name":"getUser"},{"request":{"params_new":[{"name":"forced","required":false}]},"name":"deleteBackup"},{"response":{"params_new":[{"name":"encryptionsupported"}]},"name":"addBaremetalHost"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"destroyVirtualMachine"},{"request":{"params_new":[{"name":"encryptroot","required":false}]},"response":{"params_new":[{"name":"encryptroot"}]},"name":"listServiceOfferings"},{"request":{"params_new":[{"name":"considerlasthost","required":false}]},"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"startVirtualMachine"},{"response":{"params_new":[{"name":"autoscalevmgroupid"},{"name":"autoscalevmgroupname"},{"name":"hostcontrolstate"},{"name":"userdata"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"stopVirtualMachine"},{"response":{"params_new":[{"name":"encryptroot"}]},"name":"updateServiceOffering"}],"commands_added":[{"name":"listTungstenFabricTag","description":"Lists Tungsten-Fabric tags"},{"name":"listTungstenFabricLBHealthMonitor","description":"list Tungsten-Fabric LB health monitor"},{"name":"getLoadBalancerSslCertificate","description":"get load balancer certificate"},{"name":"listTungstenFabricApplicationPolicySet","description":"list Tungsten-Fabric application policy set"},{"name":"listUserData","description":"List registered userdatas"},{"name":"applyTungstenFabricTag","description":"apply Tungsten-Fabric tag"},{"name":"createTungstenFabricFirewallPolicy","description":"create Tungsten-Fabric firewall policy"},{"name":"createTungstenFabricPolicy","description":"create Tungsten-Fabric policy"},{"name":"removeTungstenFabricPolicyRule","description":"remove Tungsten-Fabric policy"},{"name":"createTungstenFabricProvider","description":"Create Tungsten-Fabric provider in cloudstack"},{"name":"listTungstenFabricLogicalRouter","description":"list Tungsten-Fabric logical router"},{"name":"deleteTungstenFabricAddressGroup","description":"delete Tungsten-Fabric address group"},{"name":"deleteTungstenFabricLogicalRouter","description":"delete Tungsten-Fabric logical router"},{"name":"createTungstenFabricLogicalRouter","description":"create Tungsten-Fabric logical router"},{"name":"createTungstenFabricFirewallRule","description":"create Tungsten-Fabric firewall"},{"name":"createTungstenFabricManagementNetwork","description":"create Tungsten-Fabric management network"},{"name":"listTungstenFabricFirewallRule","description":"list Tungsten-Fabric firewall rule"},{"name":"listTungstenFabricAddressGroup","description":"list Tungsten-Fabric address group"},{"name":"listTungstenFabricServiceGroup","description":"list Tungsten-Fabric service group"},{"name":"isAccountAllowedToCreateOfferingsWithTags","description":"Return true if the specified account is allowed to create offerings with tags."},{"name":"createTungstenFabricTagType","description":"create Tungsten-Fabric tag type"},{"name":"assignVolume","description":"Changes ownership of a Volume from one account to another."},{"name":"deleteUserData","description":"Deletes a userdata"},{"name":"quotaTariffDelete","description":"Marks a quota tariff as removed."},{"name":"deleteTungstenFabricServiceGroup","description":"delete Tungsten-Fabric service group"},{"name":"validateUserTwoFactorAuthenticationCode","description":"Checks the 2FA code for the user."},{"name":"synchronizeTungstenFabricData","description":"Synchronize Tungsten-Fabric data"},{"name":"deleteTungstenFabricPolicy","description":"delete Tungsten-Fabric policy"},{"name":"listTungstenFabricPolicyRule","description":"list Tungsten-Fabric policy"},{"name":"resetUserDataForVirtualMachine","description":"Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state. [async]"},{"name":"listTungstenFabricNetwork","description":"list Tungsten-Fabric network"},{"name":"setupUserTwoFactorAuthentication","description":"Setup the 2FA for the user."},{"name":"linkUserDataToTemplate","description":"Link or unlink a userdata to a template."},{"name":"listTungstenFabricProviders","description":"Lists Tungsten-Fabric providers"},{"name":"deleteTungstenFabricTag","description":"delete Tungsten-Fabric tag"},{"name":"createTungstenFabricServiceGroup","description":"create Tungsten-Fabric service group"},{"name":"deleteTungstenFabricApplicationPolicySet","description":"delete Tungsten-Fabric application policy set"},{"name":"removeTungstenFabricPolicy","description":"remove Tungsten-Fabric policy"},{"name":"addTungstenFabricNetworkGatewayToLogicalRouter","description":"add Tungsten-Fabric network gateway to logical router"},{"name":"listTungstenFabricNic","description":"list Tungsten-Fabric nic"},{"name":"applyTungstenFabricPolicy","description":"apply Tungsten-Fabric policy"},{"name":"createTungstenFabricPublicNetwork","description":"create Tungsten-Fabric public network"},{"name":"listTungstenFabricFirewallPolicy","description":"list Tungsten-Fabric firewall policy"},{"name":"createTungstenFabricApplicationPolicySet","description":"create Tungsten-Fabric application policy set"},{"name":"createTungstenFabricAddressGroup","description":"create Tungsten-Fabric address group"},{"name":"listVolumesUsageHistory","description":"Lists volume stats"},{"name":"createConsoleEndpoint","description":"Create a console endpoint to connect to a VM console"},{"name":"deleteTungstenFabricFirewallPolicy","description":"delete Tungsten-Fabric firewall policy"},{"name":"updateTungstenFabricLBHealthMonitor","description":"update Tungsten-Fabric loadbalancer health monitor"},{"name":"updateCondition","description":"Updates a condition for VM auto scaling"},{"name":"removeTungstenFabricTag","description":"remove Tungsten-Fabric tag"},{"name":"listTungstenFabricPolicy","description":"list Tungsten-Fabric policy"},{"name":"listTungstenFabricVm","description":"list Tungsten-Fabric vm"},{"name":"addTungstenFabricPolicyRule","description":"add Tungsten-Fabric policy rule"},{"name":"deleteTungstenFabricTagType","description":"delete Tungsten-Fabric tag type"},{"name":"removeTungstenFabricNetworkGatewayFromLogicalRouter","description":"remove Tungsten-Fabric network gateway from logical router"},{"name":"quotaTariffCreate","description":"Creates a quota tariff for a resource."},{"name":"createTungstenFabricTag","description":"create Tungsten-Fabric tag"},{"name":"deleteTungstenFabricFirewallRule","description":"delete Tungsten-Fabric firewall rule"},{"name":"listSystemVmsUsageHistory","description":"Lists System VM stats"},{"name":"registerUserData","description":"Register a new userdata."},{"name":"listTungstenFabricTagType","description":"Lists Tungsten-Fabric tags"},{"name":"configTungstenFabricService","description":"config Tungsten-Fabric service"},{"name":"listConfigurationGroups","description":"Lists all configuration groups (primarily used for UI)."},{"name":"listUserTwoFactorAuthenticatorProviders","description":"Lists user two factor authenticator providers"}],"commands_removed":[{"name":"addExternalFirewall","description":"Adds an external firewall appliance"},{"name":"listSrxFirewalls","description":"lists SRX firewall devices in a physical network"},{"name":"deleteExternalFirewall","description":"Deletes an external firewall appliance."},{"name":"addSrxFirewall","description":"Adds a SRX firewall device"},{"name":"deleteSrxFirewall","description":" delete a SRX firewall device"},{"name":"listExternalFirewalls","description":"List external firewall appliances."},{"name":"listSrxFirewallNetworks","description":"lists network that are using SRX firewall device"},{"name":"configureSrxFirewall","description":"Configures a SRX firewall device"}],"commands_sync_changed":[]} \ No newline at end of file diff --git a/diff-417-418/diff.txt b/diff-417-418/diff.txt new file mode 100644 index 0000000..1b93f0f --- /dev/null +++ b/diff-417-418/diff.txt @@ -0,0 +1,1156 @@ +Added commands: + + listTungstenFabricTag (Lists Tungsten-Fabric tags) + + listTungstenFabricLBHealthMonitor (list Tungsten-Fabric LB health monitor) + + getLoadBalancerSslCertificate (get load balancer certificate) + + listTungstenFabricApplicationPolicySet (list Tungsten-Fabric application policy set) + + listUserData (List registered userdatas) + + applyTungstenFabricTag (apply Tungsten-Fabric tag) + + createTungstenFabricFirewallPolicy (create Tungsten-Fabric firewall policy) + + createTungstenFabricPolicy (create Tungsten-Fabric policy) + + removeTungstenFabricPolicyRule (remove Tungsten-Fabric policy) + + createTungstenFabricProvider (Create Tungsten-Fabric provider in cloudstack) + + listTungstenFabricLogicalRouter (list Tungsten-Fabric logical router) + + deleteTungstenFabricAddressGroup (delete Tungsten-Fabric address group) + + deleteTungstenFabricLogicalRouter (delete Tungsten-Fabric logical router) + + createTungstenFabricLogicalRouter (create Tungsten-Fabric logical router) + + createTungstenFabricFirewallRule (create Tungsten-Fabric firewall) + + createTungstenFabricManagementNetwork (create Tungsten-Fabric management network) + + listTungstenFabricFirewallRule (list Tungsten-Fabric firewall rule) + + listTungstenFabricAddressGroup (list Tungsten-Fabric address group) + + listTungstenFabricServiceGroup (list Tungsten-Fabric service group) + + isAccountAllowedToCreateOfferingsWithTags (Return true if the specified account is allowed to create offerings with tags.) + + createTungstenFabricTagType (create Tungsten-Fabric tag type) + + assignVolume (Changes ownership of a Volume from one account to another.) + + deleteUserData (Deletes a userdata) + + quotaTariffDelete (Marks a quota tariff as removed.) + + deleteTungstenFabricServiceGroup (delete Tungsten-Fabric service group) + + validateUserTwoFactorAuthenticationCode (Checks the 2FA code for the user.) + + synchronizeTungstenFabricData (Synchronize Tungsten-Fabric data) + + deleteTungstenFabricPolicy (delete Tungsten-Fabric policy) + + listTungstenFabricPolicyRule (list Tungsten-Fabric policy) + + resetUserDataForVirtualMachine (Resets the UserData for virtual machine. The virtual machine must be in a "Stopped" state. [async]) + + listTungstenFabricNetwork (list Tungsten-Fabric network) + + setupUserTwoFactorAuthentication (Setup the 2FA for the user.) + + linkUserDataToTemplate (Link or unlink a userdata to a template.) + + listTungstenFabricProviders (Lists Tungsten-Fabric providers) + + deleteTungstenFabricTag (delete Tungsten-Fabric tag) + + createTungstenFabricServiceGroup (create Tungsten-Fabric service group) + + deleteTungstenFabricApplicationPolicySet (delete Tungsten-Fabric application policy set) + + removeTungstenFabricPolicy (remove Tungsten-Fabric policy) + + addTungstenFabricNetworkGatewayToLogicalRouter (add Tungsten-Fabric network gateway to logical router) + + listTungstenFabricNic (list Tungsten-Fabric nic) + + applyTungstenFabricPolicy (apply Tungsten-Fabric policy) + + createTungstenFabricPublicNetwork (create Tungsten-Fabric public network) + + listTungstenFabricFirewallPolicy (list Tungsten-Fabric firewall policy) + + createTungstenFabricApplicationPolicySet (create Tungsten-Fabric application policy set) + + createTungstenFabricAddressGroup (create Tungsten-Fabric address group) + + listVolumesUsageHistory (Lists volume stats) + + createConsoleEndpoint (Create a console endpoint to connect to a VM console) + + deleteTungstenFabricFirewallPolicy (delete Tungsten-Fabric firewall policy) + + updateTungstenFabricLBHealthMonitor (update Tungsten-Fabric loadbalancer health monitor) + + updateCondition (Updates a condition for VM auto scaling) + + removeTungstenFabricTag (remove Tungsten-Fabric tag) + + listTungstenFabricPolicy (list Tungsten-Fabric policy) + + listTungstenFabricVm (list Tungsten-Fabric vm) + + addTungstenFabricPolicyRule (add Tungsten-Fabric policy rule) + + deleteTungstenFabricTagType (delete Tungsten-Fabric tag type) + + removeTungstenFabricNetworkGatewayFromLogicalRouter (remove Tungsten-Fabric network gateway from logical router) + + quotaTariffCreate (Creates a quota tariff for a resource.) + + createTungstenFabricTag (create Tungsten-Fabric tag) + + deleteTungstenFabricFirewallRule (delete Tungsten-Fabric firewall rule) + + listSystemVmsUsageHistory (Lists System VM stats) + + registerUserData (Register a new userdata.) + + listTungstenFabricTagType (Lists Tungsten-Fabric tags) + + configTungstenFabricService (config Tungsten-Fabric service) + + listConfigurationGroups (Lists all configuration groups (primarily used for UI).) + + listUserTwoFactorAuthenticatorProviders (Lists user two factor authenticator providers) + +Removed commands: + + addExternalFirewall (Adds an external firewall appliance) + + listSrxFirewalls (lists SRX firewall devices in a physical network) + + deleteExternalFirewall (Deletes an external firewall appliance.) + + addSrxFirewall (Adds a SRX firewall device) + + deleteSrxFirewall ( delete a SRX firewall device) + + listExternalFirewalls (List external firewall appliances.) + + listSrxFirewallNetworks (lists network that are using SRX firewall device) + + configureSrxFirewall (Configures a SRX firewall device) + +Changes in command type (sync versus async) + + +Changes in commands arguments: + + createPod + + Request: + + Changed parameters: startip (old version - required, new version - optional), netmask (old version - required, new version - optional), gateway (old version - required, new version - optional) + + copyIso + + Response: + + New parameters: userdataid, userdataname, userdataparams, userdatapolicy + + listVirtualMachinesMetrics + + Request: + + New parameters: autoscalevmgroupid (optional), clusterid (optional), hostid (optional), podid (optional), storageid (optional), userdata (optional) + + listHosts + + Response: + + New parameters: encryptionsupported + + rebootSystemVm + + Response: + + New parameters: hostcontrolstate + + listNetworks + + Response: + + New parameters: ip6dns1, ip6dns2, privatemtu, publicmtu, supportsvmautoscaling, tungstenvirtualrouteruuid + + registerSSHKeyPair + + Response: + + New parameters: project, projectid + + restoreVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + updateHost + + Response: + + New parameters: encryptionsupported + + listVPCOfferings + + Request: + + New parameters: domainid (optional) + + uploadVolume + + Response: + + New parameters: vmtype + + destroySystemVm + + Response: + + New parameters: hostcontrolstate + + scaleSystemVm + + Response: + + New parameters: hostcontrolstate + + stopRouter + + Response: + + New parameters: hostcontrolstate + + changeServiceForVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + startRouter + + Response: + + New parameters: hostcontrolstate + + listTemplates + + Response: + + New parameters: userdataid, userdataname, userdataparams, userdatapolicy + + resetConfiguration + + Response: + + New parameters: component, defaultvalue, displaytext, group, options, parent, subgroup, type + + createAutoScalePolicy + + Request: + + New parameters: name (optional) + + Response: + + New parameters: name + + rebootVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + updateNetworkOffering + + Response: + + New parameters: fortungsten + + updateVPC + + Request: + + New parameters: publicmtu (optional) + + Response: + + New parameters: dns1, dns2, ip6dns1, ip6dns2, publicmtu + + stopSystemVm + + Response: + + New parameters: hostcontrolstate + + createNetworkOffering + + Request: + + New parameters: fortungsten (optional) + + Response: + + New parameters: fortungsten + + listVolumesMetrics + + Request: + + New parameters: listsystemvms (optional) + + updateVmNicIp + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + startInternalLoadBalancerVM + + Response: + + New parameters: hostcontrolstate + + updateDiskOffering + + Response: + + New parameters: details, encrypt + + quotaTariffList + + Request: + + New parameters: enddate (optional), listall (optional), name (optional) + + Response: + + New parameters: activationRule, endDate, name, removed, usageTypeDescription, uuid + + listKubernetesClusters + + Response: + + New parameters: created + + createAutoScaleVmGroup + + Request: + + New parameters: name (optional) + + Response: + + New parameters: associatednetworkid, associatednetworkname, availablevirtualmachinecount, created, lbprovider, name, privateport, publicip, publicipid, publicport + + listConfigurations + + Request: + + New parameters: group (optional), parent (optional), subgroup (optional) + + Response: + + New parameters: component, defaultvalue, displaytext, group, options, parent, subgroup, type + + quotaTariffUpdate + + Request: + + New parameters: name (required), activationrule (optional), description (optional), enddate (optional) + + Changed parameters: usagetype (old version - required, new version - optional), startdate (old version - required, new version - optional), value (old version - required, new version - optional) + + Response: + + New parameters: activationRule, endDate, name, removed, usageTypeDescription, uuid + + scaleKubernetesCluster + + Response: + + New parameters: created + + stopNetScalerVpx + + Response: + + New parameters: hostcontrolstate + + listCapabilities + + Response: + + New parameters: instancesdisksstatsretentionenabled, instancesdisksstatsretentiontime, instancesstatsretentiontime, instancesstatsuseronly + + listConditions + + Request: + + New parameters: projectid (optional) + + Response: + + New parameters: counterid, countername + + destroyVolume + + Response: + + New parameters: vmtype + + disableAutoScaleVmGroup + + Response: + + New parameters: associatednetworkid, associatednetworkname, availablevirtualmachinecount, created, lbprovider, name, privateport, publicip, publicipid, publicport + + listSystemVms + + Response: + + New parameters: hostcontrolstate + + detachVolume + + Response: + + New parameters: vmtype + + changeServiceForSystemVm + + Response: + + New parameters: hostcontrolstate + + listNics + + Response: + + New parameters: mtu, vpcid, vpcname + + rebootRouter + + Response: + + New parameters: hostcontrolstate + + addNicToVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + updateIso + + Response: + + New parameters: userdataid, userdataname, userdataparams, userdatapolicy + + updateDefaultNicForVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + prepareTemplate + + Response: + + New parameters: userdataid, userdataname, userdataparams, userdatapolicy + + stopInternalLoadBalancerVM + + Response: + + New parameters: hostcontrolstate + + samlSso + + Response: + + New parameters: is2faenabled, is2faverified, issuerfor2fa, providerfor2fa + + login + + Response: + + New parameters: is2faenabled, is2faverified, issuerfor2fa, providerfor2fa + + copyTemplate + + Response: + + New parameters: userdataid, userdataname, userdataparams, userdatapolicy + + createServiceOffering + + Request: + + New parameters: encryptroot (optional) + + Response: + + New parameters: encryptroot + + listNiciraNvpDeviceNetworks + + Response: + + New parameters: ip6dns1, ip6dns2, privatemtu, publicmtu, supportsvmautoscaling, tungstenvirtualrouteruuid + + assignVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + resizeVolume + + Response: + + New parameters: vmtype + + updateTemplate + + Response: + + New parameters: userdataid, userdataname, userdataparams, userdatapolicy + + listPaloAltoFirewallNetworks + + Response: + + New parameters: ip6dns1, ip6dns2, privatemtu, publicmtu, supportsvmautoscaling, tungstenvirtualrouteruuid + + changeOfferingForVolume + + Response: + + New parameters: vmtype + + changeServiceForRouter + + Response: + + New parameters: hostcontrolstate + + updateVolume + + Response: + + New parameters: vmtype + + updateVirtualMachine + + Request: + + New parameters: userdatadetails (optional), userdataid (optional) + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + updateNetwork + + Request: + + New parameters: dns1 (optional), dns2 (optional), ip6dns1 (optional), ip6dns2 (optional), privatemtu (optional), publicmtu (optional) + + Response: + + New parameters: ip6dns1, ip6dns2, privatemtu, publicmtu, supportsvmautoscaling, tungstenvirtualrouteruuid + + migrateVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + createTemplate + + Response: + + New parameters: userdataid, userdataname, userdataparams, userdatapolicy + + resetPasswordForVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + resetSSHKeyForVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + addKubernetesSupportedVersion + + Response: + + New parameters: created + + createVPC + + Request: + + New parameters: dns1 (optional), dns2 (optional), ip6dns1 (optional), ip6dns2 (optional), publicmtu (optional) + + Response: + + New parameters: dns1, dns2, ip6dns1, ip6dns2, publicmtu + + listInternalLoadBalancerVMs + + Response: + + New parameters: hostcontrolstate + + updateKubernetesSupportedVersion + + Response: + + New parameters: created + + detachIso + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + prepareHostForMaintenance + + Response: + + New parameters: encryptionsupported + + updateAutoScaleVmGroup + + Request: + + New parameters: name (optional) + + Response: + + New parameters: associatednetworkid, associatednetworkname, availablevirtualmachinecount, created, lbprovider, name, privateport, publicip, publicipid, publicport + + updateAutoScaleVmProfile + + Request: + + New parameters: expungevmgraceperiod (optional), otherdeployparams (optional), serviceofferingid (optional), userdata (optional) + + Removed parameters: destroyvmgraceperiod + + Response: + + New parameters: expungevmgraceperiod, userdata + + Removed parameters: destroyvmgraceperiod + + enableAutoScaleVmGroup + + Response: + + New parameters: associatednetworkid, associatednetworkname, availablevirtualmachinecount, created, lbprovider, name, privateport, publicip, publicipid, publicport + + listVirtualMachines + + Request: + + New parameters: autoscalevmgroupid (optional), userdata (optional) + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + listDiskOfferings + + Request: + + New parameters: encrypt (optional) + + Response: + + New parameters: details, encrypt + + upgradeKubernetesCluster + + Response: + + New parameters: created + + createCondition + + Request: + + New parameters: projectid (optional) + + Response: + + New parameters: counterid, countername + + revertToVMSnapshot + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + registerIso + + Response: + + New parameters: userdataid, userdataname, userdataparams, userdatapolicy + + deployVirtualMachine + + Request: + + New parameters: iodriverpolicy (optional), iothreadsenabled (optional), userdatadetails (optional), userdataid (optional) + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + updateZone + + Response: + + New parameters: allowuserspecifyvrmtu, routerprivateinterfacemaxmtu, routerpublicinterfacemaxmtu, type + + cancelHostMaintenance + + Response: + + New parameters: encryptionsupported + + updateAutoScalePolicy + + Request: + + New parameters: name (optional) + + Response: + + New parameters: name + + createDiskOffering + + Request: + + New parameters: encrypt (optional) + + Response: + + New parameters: details, encrypt + + listVolumes + + Request: + + New parameters: listsystemvms (optional) + + Response: + + New parameters: vmtype + + lockUser + + Response: + + New parameters: is2faenabled, is2famandated + + createNetwork + + Request: + + New parameters: dns1 (optional), dns2 (optional), ip6dns1 (optional), ip6dns2 (optional), privatemtu (optional), publicmtu (optional), tungstenvirtualrouteruuid (optional) + + Changed parameters: displaytext (old version - required, new version - optional) + + Response: + + New parameters: ip6dns1, ip6dns2, privatemtu, publicmtu, supportsvmautoscaling, tungstenvirtualrouteruuid + + listNetworkOfferings + + Response: + + New parameters: fortungsten + + listVPCs + + Response: + + New parameters: dns1, dns2, ip6dns1, ip6dns2, publicmtu + + migrateVirtualMachineWithVolume + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + updateUser + + Request: + + New parameters: mandate2fa (optional) + + Response: + + New parameters: is2faenabled, is2famandated + + attachVolume + + Response: + + New parameters: vmtype + + addHost + + Response: + + New parameters: encryptionsupported + + listUsers + + Response: + + New parameters: is2faenabled, is2famandated + + disableUser + + Response: + + New parameters: is2faenabled, is2famandated + + listIsos + + Response: + + New parameters: userdataid, userdataname, userdataparams, userdatapolicy + + listAutoScalePolicies + + Request: + + New parameters: name (optional), projectid (optional) + + Response: + + New parameters: name + + listZones + + Response: + + New parameters: allowuserspecifyvrmtu, routerprivateinterfacemaxmtu, routerpublicinterfacemaxmtu, type + + listNetscalerLoadBalancerNetworks + + Response: + + New parameters: ip6dns1, ip6dns2, privatemtu, publicmtu, supportsvmautoscaling, tungstenvirtualrouteruuid + + startSystemVm + + Response: + + New parameters: hostcontrolstate + + createKubernetesCluster + + Response: + + New parameters: created + + declareHostAsDegraded + + Response: + + New parameters: encryptionsupported + + migrateVolume + + Response: + + New parameters: vmtype + + updateVMAffinityGroup + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + migrateVPC + + Response: + + New parameters: dns1, dns2, ip6dns1, ip6dns2, publicmtu + + updateConfiguration + + Response: + + New parameters: component, defaultvalue, displaytext, group, options, parent, subgroup, type + + recoverVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + listCounters + + Request: + + New parameters: provider (optional) + + Response: + + New parameters: provider + + migrateSystemVm + + Response: + + New parameters: hostcontrolstate + + listAutoScaleVmProfiles + + Response: + + New parameters: expungevmgraceperiod, userdata + + Removed parameters: destroyvmgraceperiod + + cancelHostAsDegraded + + Response: + + New parameters: encryptionsupported + + listRouters + + Response: + + New parameters: hostcontrolstate + + listBrocadeVcsDeviceNetworks + + Response: + + New parameters: ip6dns1, ip6dns2, privatemtu, publicmtu, supportsvmautoscaling, tungstenvirtualrouteruuid + + listKubernetesSupportedVersions + + Response: + + New parameters: created + + recoverVolume + + Response: + + New parameters: vmtype + + enableUser + + Response: + + New parameters: is2faenabled, is2famandated + + migrateNetwork + + Response: + + New parameters: ip6dns1, ip6dns2, privatemtu, publicmtu, supportsvmautoscaling, tungstenvirtualrouteruuid + + registerTemplate + + Response: + + New parameters: userdataid, userdataname, userdataparams, userdatapolicy + + createZone + + Request: + + New parameters: isedge (optional) + + Response: + + New parameters: allowuserspecifyvrmtu, routerprivateinterfacemaxmtu, routerpublicinterfacemaxmtu, type + + importUnmanagedInstance + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + listAutoScaleVmGroups + + Request: + + New parameters: name (optional) + + Response: + + New parameters: associatednetworkid, associatednetworkname, availablevirtualmachinecount, created, lbprovider, name, privateport, publicip, publicipid, publicport + + createVolume + + Response: + + New parameters: vmtype + + attachIso + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + createUser + + Response: + + New parameters: is2faenabled, is2famandated + + listSSHKeyPairs + + Response: + + New parameters: project, projectid + + destroyRouter + + Response: + + New parameters: hostcontrolstate + + quotaSummary + + Response: + + New parameters: quotaenabled + + createCounter + + Request: + + New parameters: provider (required) + + Response: + + New parameters: provider + + removeNicFromVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + deleteAutoScaleVmGroup + + Request: + + New parameters: cleanup (optional) + + createAutoScaleVmProfile + + Request: + + New parameters: account (optional), domainid (optional), expungevmgraceperiod (optional), projectid (optional), userdata (optional) + + Removed parameters: destroyvmgraceperiod + + Response: + + New parameters: expungevmgraceperiod, userdata + + Removed parameters: destroyvmgraceperiod + + reconnectHost + + Response: + + New parameters: encryptionsupported + + startKubernetesCluster + + Response: + + New parameters: created + + getUser + + Response: + + New parameters: is2faenabled, is2famandated + + deleteBackup + + Request: + + New parameters: forced (optional) + + addBaremetalHost + + Response: + + New parameters: encryptionsupported + + destroyVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + listServiceOfferings + + Request: + + New parameters: encryptroot (optional) + + Response: + + New parameters: encryptroot + + startVirtualMachine + + Request: + + New parameters: considerlasthost (optional) + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + stopVirtualMachine + + Response: + + New parameters: autoscalevmgroupid, autoscalevmgroupname, hostcontrolstate, userdata, userdatadetails, userdataid, userdataname, userdatapolicy + + updateServiceOffering + + Response: + + New parameters: encryptroot diff --git a/diff-418-419/diff.json b/diff-418-419/diff.json new file mode 100644 index 0000000..8b4c0c3 --- /dev/null +++ b/diff-418-419/diff.json @@ -0,0 +1 @@ +{"commands_args_changed":[{"request":{"params_changed":[{"required_new":false,"required_old":true,"name":"displaytext"}]},"name":"createVPCOffering"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"copyIso"},{"request":{"params_new":[{"name":"isvnf","required":false},{"name":"retrieveonlyresourcecount","required":false}]},"response":{"params_removed":[{"name":"ipaddress"}]},"name":"listVirtualMachinesMetrics"},{"response":{"params_new":[{"name":"instanceconversionsupported"},{"name":"istagarule"}]},"name":"listHosts"},{"response":{"params_new":[{"name":"istagarule"},{"name":"managed"},{"name":"nfsmountopts"},{"name":"storagecustomstats"}]},"name":"listVsphereStoragePolicyCompatiblePools"},{"request":{"params_new":[{"name":"details","required":false},{"name":"istagarule","required":false},{"name":"url","required":false}]},"response":{"params_new":[{"name":"istagarule"},{"name":"managed"},{"name":"nfsmountopts"},{"name":"storagecustomstats"}]},"name":"updateStoragePool"},{"response":{"params_new":[{"name":"serviceofferingid"},{"name":"serviceofferingname"}]},"name":"rebootSystemVm"},{"request":{"params_new":[{"name":"retrieveonlyresourcecount","required":false}]},"response":{"params_new":[{"name":"domainpath"}]},"name":"listNetworks"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listGuestVlans"},{"request":{"params_new":[{"name":"forDisplay","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"details"}]},"response":{"params_new":[{"name":"fordisplay"},{"name":"name"},{"name":"oscategoryname"}]},"name":"updateGuestOs"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateResourceLimit"},{"response":{"params_new":[{"name":"systeminstances"}]},"name":"listHostsMetrics"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listAffinityGroups"},{"request":{"params_new":[{"name":"details","required":false},{"name":"diskofferingid","required":false},{"name":"expunge","required":false},{"name":"rootdisksize","required":false}]},"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"restoreVirtualMachine"},{"response":{"params_new":[{"name":"domainpath"},{"name":"hasrules"},{"name":"virtualmachinetype"}]},"name":"reserveIpAddress"},{"request":{"params_new":[{"name":"istagarule","required":false}]},"response":{"params_new":[{"name":"instanceconversionsupported"},{"name":"istagarule"}]},"name":"updateHost"},{"response":{"params_new":[{"name":"domainpath"},{"name":"encryptformat"},{"name":"volumecheckresult"},{"name":"volumerepairresult"}]},"name":"uploadVolume"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listSecurityGroups"},{"response":{"params_new":[{"name":"serviceofferingid"},{"name":"serviceofferingname"}]},"name":"destroySystemVm"},{"response":{"params_new":[{"name":"domainpath"},{"name":"project"},{"name":"projectid"}]},"name":"listUserData"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateLoadBalancer"},{"response":{"params_new":[{"name":"serviceofferingid"},{"name":"serviceofferingname"}]},"name":"scaleSystemVm"},{"response":{"params_new":[{"name":"zone"}]},"name":"listSnapshotPolicies"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateVpnCustomerGateway"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"stopRouter"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listProjectInvitations"},{"response":{"params_new":[{"name":"drsimbalance"}]},"name":"listClustersMetrics"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createRemoteAccessVpn"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"startRouter"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"changeServiceForVirtualMachine"},{"request":{"params_new":[{"name":"osdisplayname","required":false},{"name":"osnameforhypervisor","required":false}]},"name":"listGuestOsMapping"},{"request":{"params_new":[{"name":"imagestoreid","required":false},{"name":"isvnf","required":false},{"name":"storageid","required":false},{"name":"templatetype","required":false}]},"response":{"params_new":[{"name":"domainpath"}]},"name":"listTemplates"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createAutoScalePolicy"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createAffinityGroup"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"rebootVirtualMachine"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createLoadBalancerRule"},{"request":{"params_new":[{"name":"forced","required":false},{"name":"osmappingcheckenabled","required":false}]},"name":"addGuestOsMapping"},{"response":{"params_new":[{"name":"serviceofferingid"},{"name":"serviceofferingname"}]},"name":"stopSystemVm"},{"request":{"params_new":[{"name":"sourcenatipaddress","required":false}]},"response":{"params_new":[{"name":"domainpath"}]},"name":"updateVPC"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listResourceDetails"},{"request":{"params_changed":[{"required_new":false,"required_old":true,"name":"displaytext"}]},"name":"createNetworkOffering"},{"request":{"params_new":[{"name":"isencrypted","required":false},{"name":"retrieveonlyresourcecount","required":false},{"name":"serviceofferingid","required":false}]},"name":"listVolumesMetrics"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listPrivateGateways"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"updateVmNicIp"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"startInternalLoadBalancerVM"},{"request":{"params_new":[{"name":"state","required":false}]},"response":{"params_new":[{"name":"state"}]},"name":"updateDiskOffering"},{"request":{"params_new":[{"name":"imagestoreid","required":false},{"name":"locationtype","required":false},{"name":"showunique","required":false},{"name":"storageid","required":false}]},"response":{"params_new":[{"name":"datastoreid"},{"name":"datastorename"},{"name":"datastorestate"},{"name":"datastoretype"},{"name":"domainpath"},{"name":"downloaddetails"},{"name":"status"},{"name":"volumestate"},{"name":"zonename"}]},"name":"listSnapshots"},{"request":{"params_new":[{"name":"clustertype","required":false}]},"response":{"params_new":[{"name":"clustertype"},{"name":"domainpath"}]},"name":"listKubernetesClusters"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"resetVpnConnection"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createAutoScaleVmGroup"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"stopNetScalerVpx"},{"response":{"params_new":[{"name":"clustertype"},{"name":"domainpath"}]},"name":"scaleKubernetesCluster"},{"response":{"params_new":[{"name":"customhypervisordisplayname"}]},"name":"listCapabilities"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listConditions"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listInstanceGroups"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createStaticRoute"},{"response":{"params_new":[{"name":"domainpath"},{"name":"encryptformat"},{"name":"volumecheckresult"},{"name":"volumerepairresult"}]},"name":"destroyVolume"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"disableAutoScaleVmGroup"},{"request":{"params_new":[{"name":"zoneids","required":false}]},"response":{"params_new":[{"name":"zone"}]},"name":"createSnapshotPolicy"},{"response":{"params_new":[{"name":"serviceofferingid"},{"name":"serviceofferingname"}]},"name":"listSystemVms"},{"request":{"params_changed":[{"required_new":false,"required_old":true,"name":"displaytext"}]},"name":"createProject"},{"response":{"params_new":[{"name":"domainpath"},{"name":"encryptformat"},{"name":"volumecheckresult"},{"name":"volumerepairresult"}]},"name":"detachVolume"},{"response":{"params_new":[{"name":"serviceofferingid"},{"name":"serviceofferingname"}]},"name":"changeServiceForSystemVm"},{"request":{"params_new":[{"name":"zoneids","required":false}]},"response":{"params_new":[{"name":"datastoreid"},{"name":"datastorename"},{"name":"datastorestate"},{"name":"datastoretype"},{"name":"domainpath"},{"name":"downloaddetails"},{"name":"status"},{"name":"volumestate"},{"name":"zonename"}]},"name":"createSnapshot"},{"request":{"params_new":[{"name":"hostid","required":false},{"name":"status","required":false},{"name":"storagecustomstats","required":false}]},"name":"listStoragePoolsMetrics"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"rebootRouter"},{"response":{"params_new":[{"name":"publicip"},{"name":"publicipid"}]},"name":"listNics"},{"response":{"params_new":[{"name":"datastoreid"},{"name":"datastorename"},{"name":"datastorestate"},{"name":"datastoretype"},{"name":"domainpath"},{"name":"downloaddetails"},{"name":"status"},{"name":"volumestate"},{"name":"zonename"}]},"name":"createSnapshotFromVMSnapshot"},{"request":{"params_new":[{"name":"hostid","required":false},{"name":"status","required":false},{"name":"storagecustomstats","required":false}]},"response":{"params_new":[{"name":"istagarule"},{"name":"managed"},{"name":"nfsmountopts"},{"name":"storagecustomstats"}]},"name":"listStoragePools"},{"request":{"params_new":[{"name":"hypervisor","required":false},{"name":"hypervisorversion","required":false}]},"name":"updateHypervisorCapabilities"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"addNicToVirtualMachine"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"dedicateGuestVlanRange"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listStaticRoutes"},{"request":{"params_new":[{"name":"retrieveonlyresourcecount","required":false}]},"response":{"params_new":[{"name":"domainpath"},{"name":"hasrules"},{"name":"virtualmachinetype"}]},"name":"listPublicIpAddresses"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateIso"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"updateDefaultNicForVirtualMachine"},{"request":{"params_new":[{"name":"capacitybytes","required":false},{"name":"name","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"readonly"}]},"name":"updateImageStore"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"prepareTemplate"},{"request":{"params_new":[{"name":"managementserverid","required":false}]},"response":{"params_new":[{"name":"account"},{"name":"domainid"},{"name":"domainpath"},{"name":"managementserverid"}]},"name":"listAsyncJobs"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"stopInternalLoadBalancerVM"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateSecurityGroup"},{"response":{"params_new":[{"name":"istagarule"},{"name":"managed"},{"name":"nfsmountopts"},{"name":"storagecustomstats"}]},"name":"updateStorageCapabilities"},{"response":{"params_new":[{"name":"domainpath"},{"name":"encryptformat"},{"name":"volumecheckresult"},{"name":"volumerepairresult"}]},"name":"assignVolume"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listDedicatedGuestVlanRanges"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"copyTemplate"},{"request":{"params_changed":[{"required_new":false,"required_old":true,"name":"displaytext"}]},"response":{"params_new":[{"name":"state"}]},"name":"createServiceOffering"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listNiciraNvpDeviceNetworks"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"assignVirtualMachine"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listOvsElements"},{"response":{"params_new":[{"name":"domainpath"},{"name":"encryptformat"},{"name":"volumecheckresult"},{"name":"volumerepairresult"}]},"name":"resizeVolume"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateTemplate"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateVpnConnection"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createVlanIpRange"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listPaloAltoFirewallNetworks"},{"response":{"params_new":[{"name":"serviceip"}]},"name":"listManagementServers"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateInstanceGroup"},{"response":{"params_new":[{"name":"domainpath"},{"name":"encryptformat"},{"name":"volumecheckresult"},{"name":"volumerepairresult"}]},"name":"changeOfferingForVolume"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"changeServiceForRouter"},{"response":{"params_new":[{"name":"domainpath"},{"name":"encryptformat"},{"name":"volumecheckresult"},{"name":"volumerepairresult"}]},"name":"updateVolume"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"updateVirtualMachine"},{"request":{"params_new":[{"name":"sourcenatipaddress","required":false}]},"response":{"params_new":[{"name":"domainpath"}]},"name":"updateNetwork"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"resetUserDataForVirtualMachine"},{"response":{"params_new":[{"name":"datastoreid"},{"name":"datastorename"},{"name":"datastorestate"},{"name":"datastoretype"},{"name":"domainpath"},{"name":"downloaddetails"},{"name":"status"},{"name":"volumestate"},{"name":"zonename"}]},"name":"archiveSnapshot"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateVpnGateway"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"migrateVirtualMachine"},{"request":{"params_new":[{"name":"account","required":false},{"name":"domainid","required":false},{"name":"zoneid","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"displaytext"}]},"response":{"params_new":[{"name":"domainpath"}]},"name":"createTemplate"},{"request":{"params_new":[{"name":"password","required":false}]},"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"resetPasswordForVirtualMachine"},{"response":{"params_new":[{"name":"domainpath"},{"name":"hasrules"},{"name":"virtualmachinetype"}]},"name":"associateIpAddress"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listVpnCustomerGateways"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"resetSSHKeyForVirtualMachine"},{"request":{"params_new":[{"name":"directdownload","required":false}]},"response":{"params_new":[{"name":"directdownload"}]},"name":"addKubernetesSupportedVersion"},{"request":{"params_new":[{"name":"cleanup","required":false},{"name":"expunge","required":false}]},"name":"deleteKubernetesCluster"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createGlobalLoadBalancerRule"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"linkUserDataToTemplate"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listGlobalLoadBalancerRules"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listTags"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createVirtualRouterElement"},{"request":{"params_new":[{"name":"sourcenatipaddress","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"displaytext"}]},"response":{"params_new":[{"name":"domainpath"}]},"name":"createVPC"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listInternalLoadBalancerVMs"},{"request":{"params_new":[{"name":"fordisplay","required":false}]},"response":{"params_new":[{"name":"fordisplay"},{"name":"name"},{"name":"oscategoryname"}]},"name":"listOsTypes"},{"response":{"params_new":[{"name":"directdownload"}]},"name":"updateKubernetesSupportedVersion"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"detachIso"},{"response":{"params_new":[{"name":"instanceconversionsupported"},{"name":"istagarule"}]},"name":"prepareHostForMaintenance"},{"request":{"params_new":[{"name":"ispublic","required":false}]},"name":"createRole"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateAutoScaleVmGroup"},{"request":{"params_new":[{"name":"userdatadetails","required":false},{"name":"userdataid","required":false}]},"response":{"params_new":[{"name":"domainpath"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"updateAutoScaleVmProfile"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"enableAutoScaleVmGroup"},{"request":{"params_new":[{"name":"zoneid","required":false}]},"name":"deleteSnapshot"},{"request":{"params_new":[{"name":"isvnf","required":false},{"name":"retrieveonlyresourcecount","required":false}]},"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"listVirtualMachines"},{"request":{"params_new":[{"name":"osmappingcheckenabled","required":false}]},"name":"updateGuestOsMapping"},{"request":{"params_new":[{"name":"account","required":false},{"name":"projectid","required":false},{"name":"state","required":false},{"name":"storagetype","required":false}]},"response":{"params_new":[{"name":"state"}]},"name":"listDiskOfferings"},{"response":{"params_new":[{"name":"clustertype"},{"name":"domainpath"}]},"name":"upgradeKubernetesCluster"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateGlobalLoadBalancerRule"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createCondition"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"revertToVMSnapshot"},{"request":{"params_new":[{"name":"forDisplay","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"details"}]},"response":{"params_new":[{"name":"fordisplay"},{"name":"name"},{"name":"oscategoryname"}]},"name":"addGuestOs"},{"request":{"params_changed":[{"required_new":false,"required_old":true,"name":"displaytext"}]},"response":{"params_new":[{"name":"domainpath"}]},"name":"registerIso"},{"request":{"params_new":[{"name":"nicmultiqueuenumber","required":false},{"name":"nicpackedvirtqueuesenabled","required":false},{"name":"password","required":false}]},"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"deployVirtualMachine"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listVlanIpRanges"},{"response":{"params_new":[{"name":"instanceconversionsupported"},{"name":"istagarule"}]},"name":"cancelHostMaintenance"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateAutoScalePolicy"},{"request":{"params_changed":[{"required_new":false,"required_old":true,"name":"displaytext"}]},"response":{"params_new":[{"name":"state"}]},"name":"createDiskOffering"},{"request":{"params_new":[{"name":"isencrypted","required":false},{"name":"retrieveonlyresourcecount","required":false},{"name":"serviceofferingid","required":false}]},"response":{"params_new":[{"name":"domainpath"},{"name":"encryptformat"},{"name":"volumecheckresult"},{"name":"volumerepairresult"}]},"name":"listVolumes"},{"request":{"params_new":[{"name":"sourcenatipaddress","required":false}]},"response":{"params_new":[{"name":"domainpath"}]},"name":"createNetwork"},{"request":{"params_new":[{"name":"autoselect","required":false}]},"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"migrateVirtualMachineWithVolume"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listVPCs"},{"response":{"params_new":[{"name":"instanceconversionsupported"},{"name":"istagarule"}]},"name":"addHost"},{"response":{"params_new":[{"name":"domainpath"},{"name":"encryptformat"},{"name":"volumecheckresult"},{"name":"volumerepairresult"}]},"name":"attachVolume"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listLoadBalancers"},{"request":{"params_new":[{"name":"name","required":false}]},"name":"updateProject"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listVpnConnections"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateVlanIpRange"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listResourceLimits"},{"request":{"params_new":[{"name":"imagestoreid","required":false},{"name":"storageid","required":false}]},"response":{"params_new":[{"name":"domainpath"}]},"name":"listIsos"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listAutoScalePolicies"},{"request":{"params_new":[{"name":"ispublic","required":false}]},"name":"updateRole"},{"request":{"params_new":[{"name":"ids","required":false}]},"name":"listZones"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listRemoteAccessVpns"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createServiceInstance"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listNetscalerLoadBalancerNetworks"},{"response":{"params_new":[{"name":"serviceofferingid"},{"name":"serviceofferingname"}]},"name":"startSystemVm"},{"response":{"params_new":[{"name":"instanceconversionsupported"},{"name":"istagarule"}]},"name":"declareHostAsDegraded"},{"request":{"params_new":[{"name":"clustertype","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"description"},{"required_new":false,"required_old":true,"name":"kubernetesversionid"},{"required_new":false,"required_old":true,"name":"size"},{"required_new":false,"required_old":true,"name":"serviceofferingid"}]},"response":{"params_new":[{"name":"clustertype"},{"name":"domainpath"}]},"name":"createKubernetesCluster"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"configureVirtualRouterElement"},{"response":{"params_new":[{"name":"domainpath"},{"name":"encryptformat"},{"name":"volumecheckresult"},{"name":"volumerepairresult"}]},"name":"migrateVolume"},{"request":{"params_new":[{"name":"archived","required":false}]},"response":{"params_new":[{"name":"archived"},{"name":"domainpath"}]},"name":"listEvents"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"updateVMAffinityGroup"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"migrateVPC"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"dedicatePublicIpRange"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"recoverVirtualMachine"},{"request":{"params_changed":[{"required_new":false,"required_old":true,"name":"displaytext"}]},"name":"getUploadParamsForTemplate"},{"response":{"params_new":[{"name":"datastoreid"},{"name":"datastorename"},{"name":"datastorestate"},{"name":"datastoretype"},{"name":"domainpath"},{"name":"downloaddetails"},{"name":"status"},{"name":"volumestate"},{"name":"zonename"}]},"name":"revertSnapshot"},{"response":{"params_new":[{"name":"serviceofferingid"},{"name":"serviceofferingname"}]},"name":"migrateSystemVm"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listVirtualRouterElements"},{"request":{"params_new":[{"name":"roleid","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"accounttype"}]},"name":"linkAccountToLdap"},{"response":{"params_new":[{"name":"domainpath"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"listAutoScaleVmProfiles"},{"response":{"params_new":[{"name":"instanceconversionsupported"},{"name":"istagarule"}]},"name":"cancelHostAsDegraded"},{"response":{"params_new":[{"name":"istagarule"},{"name":"managed"},{"name":"nfsmountopts"},{"name":"storagecustomstats"}]},"name":"syncStoragePool"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createSecurityGroup"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listVpnGateways"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateResourceCount"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listRouters"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createVpnConnection"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listBrocadeVcsDeviceNetworks"},{"request":{"params_new":[{"name":"ispublic","required":false}]},"name":"importRole"},{"response":{"params_new":[{"name":"directdownload"}]},"name":"listKubernetesSupportedVersions"},{"response":{"params_new":[{"name":"objectstores"}]},"name":"listInfrastructure"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listUsageRecords"},{"response":{"params_new":[{"name":"domainpath"},{"name":"encryptformat"},{"name":"volumecheckresult"},{"name":"volumerepairresult"}]},"name":"recoverVolume"},{"request":{"params_new":[{"name":"ids","required":false}]},"name":"listZonesMetrics"},{"response":{"params_new":[{"name":"domainpath"},{"name":"hasrules"},{"name":"virtualmachinetype"}]},"name":"updateIpAddress"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"migrateNetwork"},{"response":{"params_new":[{"name":"clustername"}]},"name":"listUnmanagedInstances"},{"request":{"params_new":[{"name":"templatetype","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"displaytext"}]},"response":{"params_new":[{"name":"domainpath"}]},"name":"registerTemplate"},{"response":{"params_new":[{"name":"istagarule"},{"name":"managed"},{"name":"nfsmountopts"},{"name":"storagecustomstats"}]},"name":"findStoragePoolsForMigration"},{"request":{"params_new":[{"name":"istagarule","required":false}]},"response":{"params_new":[{"name":"istagarule"},{"name":"managed"},{"name":"nfsmountopts"},{"name":"storagecustomstats"}]},"name":"createStoragePool"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"configureOvsElement"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"importUnmanagedInstance"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listAutoScaleVmGroups"},{"response":{"params_new":[{"name":"domainpath"},{"name":"encryptformat"},{"name":"volumecheckresult"},{"name":"volumerepairresult"}]},"name":"createVolume"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listVMSnapshot"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"attachIso"},{"request":{"params_new":[{"name":"ipaddress","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"id"}]},"name":"disassociateIpAddress"},{"response":{"params_new":[{"name":"istagarule"},{"name":"managed"},{"name":"nfsmountopts"},{"name":"storagecustomstats"}]},"name":"enableStorageMaintenance"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createVpnGateway"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createVMSnapshot"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listVpnUsers"},{"response":{"params_new":[{"name":"istagarule"},{"name":"managed"},{"name":"nfsmountopts"},{"name":"storagecustomstats"}]},"name":"cancelStorageMaintenance"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"destroyRouter"},{"response":{"params_new":[{"name":"zone"}]},"name":"updateSnapshotPolicy"},{"response":{"params_new":[{"name":"account"},{"name":"domainid"},{"name":"domainpath"},{"name":"managementserverid"}]},"name":"queryAsyncJobResult"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"removeNicFromVirtualMachine"},{"request":{"params_changed":[{"required_new":false,"required_old":true,"name":"displaytext"}]},"name":"getUploadParamsForIso"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateLoadBalancerRule"},{"request":{"params_new":[{"name":"userdatadetails","required":false},{"name":"userdataid","required":false}]},"response":{"params_new":[{"name":"domainpath"},{"name":"userdatadetails"},{"name":"userdataid"},{"name":"userdataname"},{"name":"userdatapolicy"}]},"name":"createAutoScaleVmProfile"},{"response":{"params_new":[{"name":"clustertype"},{"name":"domainpath"}]},"name":"startKubernetesCluster"},{"response":{"params_new":[{"name":"instanceconversionsupported"},{"name":"istagarule"}]},"name":"reconnectHost"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createInstanceGroup"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createLoadBalancer"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createPrivateGateway"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"listLoadBalancerRules"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"createVpnCustomerGateway"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"addVpnUser"},{"response":{"params_new":[{"name":"instanceconversionsupported"},{"name":"istagarule"}]},"name":"addBaremetalHost"},{"response":{"params_new":[{"name":"domainpath"}]},"name":"updateRemoteAccessVpn"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"destroyVirtualMachine"},{"request":{"params_new":[{"name":"account","required":false},{"name":"projectid","required":false},{"name":"state","required":false},{"name":"storagetype","required":false}]},"response":{"params_new":[{"name":"state"}]},"name":"listServiceOfferings"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"startVirtualMachine"},{"request":{"params_new":[{"name":"state","required":false}]},"response":{"params_new":[{"name":"state"}]},"name":"updateServiceOffering"},{"response":{"params_new":[{"name":"domainpath"},{"name":"ipaddress"},{"name":"templateformat"},{"name":"templatetype"},{"name":"vnfdetails"},{"name":"vnfnics"}]},"name":"stopVirtualMachine"},{"request":{"params_changed":[{"required_new":false,"required_old":true,"name":"vpcid"}]},"name":"createNetworkACLList"}],"commands_added":[{"name":"listOauthProvider","description":"List OAuth providers registered"},{"name":"verifyOAuthCodeAndGetUser","description":"Verify the OAuth Code and fetch the corresponding user from provider"},{"name":"listClusterDrsPlan","description":"List DRS plans for a clusters"},{"name":"listStoragePoolObjects","description":"Lists objects at specified path on a storage pool."},{"name":"listObjectStoragePools","description":"Lists object storage pools."},{"name":"listVMSchedule","description":"List VM Schedules."},{"name":"removeVirtualMachinesFromKubernetesCluster","description":"Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters."},{"name":"checkVolume","description":"Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only"},{"name":"unmanageVolume","description":"Unmanage a volume on storage pool."},{"name":"createVMSchedule","description":"Create VM Schedule"},{"name":"generateClusterDrsPlan","description":"Generate DRS plan for a cluster"},{"name":"createSecondaryStorageSelector","description":"Creates a secondary storage selector, described by the heuristic rule."},{"name":"triggerShutdown","description":"Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced"},{"name":"listAffectedVmsForStorageScopeChange","description":"List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster."},{"name":"removeQuarantinedIp","description":"Removes a public IP address from quarantine. Only IPs in active quarantine can be removed."},{"name":"deleteBucket","description":"Deletes an empty Bucket."},{"name":"deleteObjectStoragePool","description":"Deletes an Object Storage Pool"},{"name":"updateSecondaryStorageSelector","description":"Updates an existing secondary storage selector."},{"name":"registerOauthProvider","description":"Register the OAuth2 provider in CloudStack"},{"name":"deleteVnfTemplate","description":"Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected."},{"name":"updateOauthProvider","description":"Updates the registered OAuth provider details"},{"name":"updateVMSchedule","description":"Update VM Schedule."},{"name":"moveDomain","description":"Moves a domain and its children to a new parent domain."},{"name":"deleteOauthProvider","description":"Deletes the registered OAuth provider"},{"name":"cancelShutdown","description":"Cancels a triggered shutdown"},{"name":"deleteVMSchedule","description":"Delete VM Schedule."},{"name":"updateObjectStoragePool","description":"Updates object storage pool"},{"name":"createBucket","description":"Creates a bucket in the specified object storage pool. "},{"name":"oauthlogin","description":"Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired."},{"name":"getHypervisorGuestOsNames","description":"Gets the guest OS names in the hypervisor"},{"name":"addVirtualMachinesToKubernetesCluster","description":"Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters."},{"name":"listVnfTemplates","description":"List all public, private, and privileged VNF templates."},{"name":"deployVnfAppliance","description":"Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template."},{"name":"migrateResourceToAnotherSecondaryStorage","description":"migrates resources from one secondary storage to destination image store"},{"name":"readyForShutdown","description":"Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown"},{"name":"listSecondaryStorageSelectors","description":"Lists the secondary storage selectors and their rules."},{"name":"listImageStoreObjects","description":"Lists objects at specified path on an image store."},{"name":"listBuckets","description":"Lists all Buckets."},{"name":"listVmsForImport","description":"Lists virtual machines on a unmanaged host"},{"name":"addObjectStoragePool","description":"Adds a object storage pool"},{"name":"importVolume","description":"Import an unmanaged volume from a storage pool on a host into CloudStack"},{"name":"listAlertTypes","description":"Lists all alerts types"},{"name":"executeClusterDrsPlan","description":"Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail."},{"name":"listVmwareDcVms","description":"Lists the VMs in a VMware Datacenter"},{"name":"copySnapshot","description":"Copies a snapshot from one zone to another."},{"name":"registerVnfTemplate","description":"Registers an existing VNF template into the CloudStack cloud. "},{"name":"updateBucket","description":"Updates Bucket properties"},{"name":"downloadImageStoreObject","description":"Download object at a specified path on an image store."},{"name":"listQuarantinedIps","description":"List public IP addresses in quarantine."},{"name":"listVolumesForImport","description":"Lists unmanaged volumes on a storage pool"},{"name":"listVnfAppliances","description":"List VNF appliance owned by the account."},{"name":"removeSecondaryStorageSelector","description":"Removes an existing secondary storage selector."},{"name":"prepareForShutdown","description":"Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted"},{"name":"changeStoragePoolScope","description":"Changes the scope of a storage pool when the pool is in Disabled state.This feature is officially tested and supported for Hypervisors: KVM and VMware, Protocols: NFS and Ceph, and Storage Provider: DefaultPrimary. There might be extra steps involved to make this work for other hypervisors and storage options."},{"name":"updateQuarantinedIp","description":"Updates the quarantine end date for the given public IP address."},{"name":"updateVnfTemplate","description":"Updates a template to VNF template or attributes of a VNF template."},{"name":"importVm","description":"Import virtual machine from a unmanaged host into CloudStack"}],"commands_removed":[],"commands_sync_changed":[]} \ No newline at end of file diff --git a/diff-418-419/diff.txt b/diff-418-419/diff.txt new file mode 100644 index 0000000..8dc7a83 --- /dev/null +++ b/diff-418-419/diff.txt @@ -0,0 +1,1690 @@ +Added commands: + + listOauthProvider (List OAuth providers registered) + + verifyOAuthCodeAndGetUser (Verify the OAuth Code and fetch the corresponding user from provider) + + listClusterDrsPlan (List DRS plans for a clusters) + + listStoragePoolObjects (Lists objects at specified path on a storage pool.) + + listObjectStoragePools (Lists object storage pools.) + + listVMSchedule (List VM Schedules.) + + removeVirtualMachinesFromKubernetesCluster (Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.) + + checkVolume (Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only) + + unmanageVolume (Unmanage a volume on storage pool.) + + createVMSchedule (Create VM Schedule) + + generateClusterDrsPlan (Generate DRS plan for a cluster) + + createSecondaryStorageSelector (Creates a secondary storage selector, described by the heuristic rule.) + + triggerShutdown (Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced) + + listAffectedVmsForStorageScopeChange (List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster.) + + removeQuarantinedIp (Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.) + + deleteBucket (Deletes an empty Bucket.) + + deleteObjectStoragePool (Deletes an Object Storage Pool) + + updateSecondaryStorageSelector (Updates an existing secondary storage selector.) + + registerOauthProvider (Register the OAuth2 provider in CloudStack) + + deleteVnfTemplate (Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected.) + + updateOauthProvider (Updates the registered OAuth provider details) + + updateVMSchedule (Update VM Schedule.) + + moveDomain (Moves a domain and its children to a new parent domain.) + + deleteOauthProvider (Deletes the registered OAuth provider) + + cancelShutdown (Cancels a triggered shutdown) + + deleteVMSchedule (Delete VM Schedule.) + + updateObjectStoragePool (Updates object storage pool) + + createBucket (Creates a bucket in the specified object storage pool. ) + + oauthlogin (Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired.) + + getHypervisorGuestOsNames (Gets the guest OS names in the hypervisor) + + addVirtualMachinesToKubernetesCluster (Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.) + + listVnfTemplates (List all public, private, and privileged VNF templates.) + + deployVnfAppliance (Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.) + + migrateResourceToAnotherSecondaryStorage (migrates resources from one secondary storage to destination image store) + + readyForShutdown (Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown) + + listSecondaryStorageSelectors (Lists the secondary storage selectors and their rules.) + + listImageStoreObjects (Lists objects at specified path on an image store.) + + listBuckets (Lists all Buckets.) + + listVmsForImport (Lists virtual machines on a unmanaged host) + + addObjectStoragePool (Adds a object storage pool) + + importVolume (Import an unmanaged volume from a storage pool on a host into CloudStack) + + listAlertTypes (Lists all alerts types) + + executeClusterDrsPlan (Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail.) + + listVmwareDcVms (Lists the VMs in a VMware Datacenter) + + copySnapshot (Copies a snapshot from one zone to another.) + + registerVnfTemplate (Registers an existing VNF template into the CloudStack cloud. ) + + updateBucket (Updates Bucket properties) + + downloadImageStoreObject (Download object at a specified path on an image store.) + + listQuarantinedIps (List public IP addresses in quarantine.) + + listVolumesForImport (Lists unmanaged volumes on a storage pool) + + listVnfAppliances (List VNF appliance owned by the account.) + + removeSecondaryStorageSelector (Removes an existing secondary storage selector.) + + prepareForShutdown (Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted) + + changeStoragePoolScope (Changes the scope of a storage pool when the pool is in Disabled state.This feature is officially tested and supported for Hypervisors: KVM and VMware, Protocols: NFS and Ceph, and Storage Provider: DefaultPrimary. There might be extra steps involved to make this work for other hypervisors and storage options.) + + updateQuarantinedIp (Updates the quarantine end date for the given public IP address.) + + updateVnfTemplate (Updates a template to VNF template or attributes of a VNF template.) + + importVm (Import virtual machine from a unmanaged host into CloudStack) + +Removed commands: + +Changes in command type (sync versus async) + + +Changes in commands arguments: + + createVPCOffering + + Request: + + Changed parameters: displaytext (old version - required, new version - optional) + + copyIso + + Response: + + New parameters: domainpath + + listVirtualMachinesMetrics + + Request: + + New parameters: isvnf (optional), retrieveonlyresourcecount (optional) + + Response: + + Removed parameters: ipaddress + + listHosts + + Response: + + New parameters: instanceconversionsupported, istagarule + + listVsphereStoragePolicyCompatiblePools + + Response: + + New parameters: istagarule, managed, nfsmountopts, storagecustomstats + + updateStoragePool + + Request: + + New parameters: details (optional), istagarule (optional), url (optional) + + Response: + + New parameters: istagarule, managed, nfsmountopts, storagecustomstats + + rebootSystemVm + + Response: + + New parameters: serviceofferingid, serviceofferingname + + listNetworks + + Request: + + New parameters: retrieveonlyresourcecount (optional) + + Response: + + New parameters: domainpath + + listGuestVlans + + Response: + + New parameters: domainpath + + updateGuestOs + + Request: + + New parameters: forDisplay (optional) + + Changed parameters: details (old version - required, new version - optional) + + Response: + + New parameters: fordisplay, name, oscategoryname + + updateResourceLimit + + Response: + + New parameters: domainpath + + listHostsMetrics + + Response: + + New parameters: systeminstances + + listAffinityGroups + + Response: + + New parameters: domainpath + + restoreVirtualMachine + + Request: + + New parameters: details (optional), diskofferingid (optional), expunge (optional), rootdisksize (optional) + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + reserveIpAddress + + Response: + + New parameters: domainpath, hasrules, virtualmachinetype + + updateHost + + Request: + + New parameters: istagarule (optional) + + Response: + + New parameters: instanceconversionsupported, istagarule + + uploadVolume + + Response: + + New parameters: domainpath, encryptformat, volumecheckresult, volumerepairresult + + listSecurityGroups + + Response: + + New parameters: domainpath + + destroySystemVm + + Response: + + New parameters: serviceofferingid, serviceofferingname + + listUserData + + Response: + + New parameters: domainpath, project, projectid + + updateLoadBalancer + + Response: + + New parameters: domainpath + + scaleSystemVm + + Response: + + New parameters: serviceofferingid, serviceofferingname + + listSnapshotPolicies + + Response: + + New parameters: zone + + updateVpnCustomerGateway + + Response: + + New parameters: domainpath + + stopRouter + + Response: + + New parameters: domainpath + + listProjectInvitations + + Response: + + New parameters: domainpath + + listClustersMetrics + + Response: + + New parameters: drsimbalance + + createRemoteAccessVpn + + Response: + + New parameters: domainpath + + startRouter + + Response: + + New parameters: domainpath + + changeServiceForVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + listGuestOsMapping + + Request: + + New parameters: osdisplayname (optional), osnameforhypervisor (optional) + + listTemplates + + Request: + + New parameters: imagestoreid (optional), isvnf (optional), storageid (optional), templatetype (optional) + + Response: + + New parameters: domainpath + + createAutoScalePolicy + + Response: + + New parameters: domainpath + + createAffinityGroup + + Response: + + New parameters: domainpath + + rebootVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + createLoadBalancerRule + + Response: + + New parameters: domainpath + + addGuestOsMapping + + Request: + + New parameters: forced (optional), osmappingcheckenabled (optional) + + stopSystemVm + + Response: + + New parameters: serviceofferingid, serviceofferingname + + updateVPC + + Request: + + New parameters: sourcenatipaddress (optional) + + Response: + + New parameters: domainpath + + listResourceDetails + + Response: + + New parameters: domainpath + + createNetworkOffering + + Request: + + Changed parameters: displaytext (old version - required, new version - optional) + + listVolumesMetrics + + Request: + + New parameters: isencrypted (optional), retrieveonlyresourcecount (optional), serviceofferingid (optional) + + listPrivateGateways + + Response: + + New parameters: domainpath + + updateVmNicIp + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + startInternalLoadBalancerVM + + Response: + + New parameters: domainpath + + updateDiskOffering + + Request: + + New parameters: state (optional) + + Response: + + New parameters: state + + listSnapshots + + Request: + + New parameters: imagestoreid (optional), locationtype (optional), showunique (optional), storageid (optional) + + Response: + + New parameters: datastoreid, datastorename, datastorestate, datastoretype, domainpath, downloaddetails, status, volumestate, zonename + + listKubernetesClusters + + Request: + + New parameters: clustertype (optional) + + Response: + + New parameters: clustertype, domainpath + + resetVpnConnection + + Response: + + New parameters: domainpath + + createAutoScaleVmGroup + + Response: + + New parameters: domainpath + + stopNetScalerVpx + + Response: + + New parameters: domainpath + + scaleKubernetesCluster + + Response: + + New parameters: clustertype, domainpath + + listCapabilities + + Response: + + New parameters: customhypervisordisplayname + + listConditions + + Response: + + New parameters: domainpath + + listInstanceGroups + + Response: + + New parameters: domainpath + + createStaticRoute + + Response: + + New parameters: domainpath + + destroyVolume + + Response: + + New parameters: domainpath, encryptformat, volumecheckresult, volumerepairresult + + disableAutoScaleVmGroup + + Response: + + New parameters: domainpath + + createSnapshotPolicy + + Request: + + New parameters: zoneids (optional) + + Response: + + New parameters: zone + + listSystemVms + + Response: + + New parameters: serviceofferingid, serviceofferingname + + createProject + + Request: + + Changed parameters: displaytext (old version - required, new version - optional) + + detachVolume + + Response: + + New parameters: domainpath, encryptformat, volumecheckresult, volumerepairresult + + changeServiceForSystemVm + + Response: + + New parameters: serviceofferingid, serviceofferingname + + createSnapshot + + Request: + + New parameters: zoneids (optional) + + Response: + + New parameters: datastoreid, datastorename, datastorestate, datastoretype, domainpath, downloaddetails, status, volumestate, zonename + + listStoragePoolsMetrics + + Request: + + New parameters: hostid (optional), status (optional), storagecustomstats (optional) + + rebootRouter + + Response: + + New parameters: domainpath + + listNics + + Response: + + New parameters: publicip, publicipid + + createSnapshotFromVMSnapshot + + Response: + + New parameters: datastoreid, datastorename, datastorestate, datastoretype, domainpath, downloaddetails, status, volumestate, zonename + + listStoragePools + + Request: + + New parameters: hostid (optional), status (optional), storagecustomstats (optional) + + Response: + + New parameters: istagarule, managed, nfsmountopts, storagecustomstats + + updateHypervisorCapabilities + + Request: + + New parameters: hypervisor (optional), hypervisorversion (optional) + + addNicToVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + dedicateGuestVlanRange + + Response: + + New parameters: domainpath + + listStaticRoutes + + Response: + + New parameters: domainpath + + listPublicIpAddresses + + Request: + + New parameters: retrieveonlyresourcecount (optional) + + Response: + + New parameters: domainpath, hasrules, virtualmachinetype + + updateIso + + Response: + + New parameters: domainpath + + updateDefaultNicForVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + updateImageStore + + Request: + + New parameters: capacitybytes (optional), name (optional) + + Changed parameters: readonly (old version - required, new version - optional) + + prepareTemplate + + Response: + + New parameters: domainpath + + listAsyncJobs + + Request: + + New parameters: managementserverid (optional) + + Response: + + New parameters: account, domainid, domainpath, managementserverid + + stopInternalLoadBalancerVM + + Response: + + New parameters: domainpath + + updateSecurityGroup + + Response: + + New parameters: domainpath + + updateStorageCapabilities + + Response: + + New parameters: istagarule, managed, nfsmountopts, storagecustomstats + + assignVolume + + Response: + + New parameters: domainpath, encryptformat, volumecheckresult, volumerepairresult + + listDedicatedGuestVlanRanges + + Response: + + New parameters: domainpath + + copyTemplate + + Response: + + New parameters: domainpath + + createServiceOffering + + Request: + + Changed parameters: displaytext (old version - required, new version - optional) + + Response: + + New parameters: state + + listNiciraNvpDeviceNetworks + + Response: + + New parameters: domainpath + + assignVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + listOvsElements + + Response: + + New parameters: domainpath + + resizeVolume + + Response: + + New parameters: domainpath, encryptformat, volumecheckresult, volumerepairresult + + updateTemplate + + Response: + + New parameters: domainpath + + updateVpnConnection + + Response: + + New parameters: domainpath + + createVlanIpRange + + Response: + + New parameters: domainpath + + listPaloAltoFirewallNetworks + + Response: + + New parameters: domainpath + + listManagementServers + + Response: + + New parameters: serviceip + + updateInstanceGroup + + Response: + + New parameters: domainpath + + changeOfferingForVolume + + Response: + + New parameters: domainpath, encryptformat, volumecheckresult, volumerepairresult + + changeServiceForRouter + + Response: + + New parameters: domainpath + + updateVolume + + Response: + + New parameters: domainpath, encryptformat, volumecheckresult, volumerepairresult + + updateVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + updateNetwork + + Request: + + New parameters: sourcenatipaddress (optional) + + Response: + + New parameters: domainpath + + resetUserDataForVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + archiveSnapshot + + Response: + + New parameters: datastoreid, datastorename, datastorestate, datastoretype, domainpath, downloaddetails, status, volumestate, zonename + + updateVpnGateway + + Response: + + New parameters: domainpath + + migrateVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + createTemplate + + Request: + + New parameters: account (optional), domainid (optional), zoneid (optional) + + Changed parameters: displaytext (old version - required, new version - optional) + + Response: + + New parameters: domainpath + + resetPasswordForVirtualMachine + + Request: + + New parameters: password (optional) + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + associateIpAddress + + Response: + + New parameters: domainpath, hasrules, virtualmachinetype + + listVpnCustomerGateways + + Response: + + New parameters: domainpath + + resetSSHKeyForVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + addKubernetesSupportedVersion + + Request: + + New parameters: directdownload (optional) + + Response: + + New parameters: directdownload + + deleteKubernetesCluster + + Request: + + New parameters: cleanup (optional), expunge (optional) + + createGlobalLoadBalancerRule + + Response: + + New parameters: domainpath + + linkUserDataToTemplate + + Response: + + New parameters: domainpath + + listGlobalLoadBalancerRules + + Response: + + New parameters: domainpath + + listTags + + Response: + + New parameters: domainpath + + createVirtualRouterElement + + Response: + + New parameters: domainpath + + createVPC + + Request: + + New parameters: sourcenatipaddress (optional) + + Changed parameters: displaytext (old version - required, new version - optional) + + Response: + + New parameters: domainpath + + listInternalLoadBalancerVMs + + Response: + + New parameters: domainpath + + listOsTypes + + Request: + + New parameters: fordisplay (optional) + + Response: + + New parameters: fordisplay, name, oscategoryname + + updateKubernetesSupportedVersion + + Response: + + New parameters: directdownload + + detachIso + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + prepareHostForMaintenance + + Response: + + New parameters: instanceconversionsupported, istagarule + + createRole + + Request: + + New parameters: ispublic (optional) + + updateAutoScaleVmGroup + + Response: + + New parameters: domainpath + + updateAutoScaleVmProfile + + Request: + + New parameters: userdatadetails (optional), userdataid (optional) + + Response: + + New parameters: domainpath, userdatadetails, userdataid, userdataname, userdatapolicy + + enableAutoScaleVmGroup + + Response: + + New parameters: domainpath + + deleteSnapshot + + Request: + + New parameters: zoneid (optional) + + listVirtualMachines + + Request: + + New parameters: isvnf (optional), retrieveonlyresourcecount (optional) + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + updateGuestOsMapping + + Request: + + New parameters: osmappingcheckenabled (optional) + + listDiskOfferings + + Request: + + New parameters: account (optional), projectid (optional), state (optional), storagetype (optional) + + Response: + + New parameters: state + + upgradeKubernetesCluster + + Response: + + New parameters: clustertype, domainpath + + updateGlobalLoadBalancerRule + + Response: + + New parameters: domainpath + + createCondition + + Response: + + New parameters: domainpath + + revertToVMSnapshot + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + addGuestOs + + Request: + + New parameters: forDisplay (optional) + + Changed parameters: details (old version - required, new version - optional) + + Response: + + New parameters: fordisplay, name, oscategoryname + + registerIso + + Request: + + Changed parameters: displaytext (old version - required, new version - optional) + + Response: + + New parameters: domainpath + + deployVirtualMachine + + Request: + + New parameters: nicmultiqueuenumber (optional), nicpackedvirtqueuesenabled (optional), password (optional) + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + listVlanIpRanges + + Response: + + New parameters: domainpath + + cancelHostMaintenance + + Response: + + New parameters: instanceconversionsupported, istagarule + + updateAutoScalePolicy + + Response: + + New parameters: domainpath + + createDiskOffering + + Request: + + Changed parameters: displaytext (old version - required, new version - optional) + + Response: + + New parameters: state + + listVolumes + + Request: + + New parameters: isencrypted (optional), retrieveonlyresourcecount (optional), serviceofferingid (optional) + + Response: + + New parameters: domainpath, encryptformat, volumecheckresult, volumerepairresult + + createNetwork + + Request: + + New parameters: sourcenatipaddress (optional) + + Response: + + New parameters: domainpath + + migrateVirtualMachineWithVolume + + Request: + + New parameters: autoselect (optional) + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + listVPCs + + Response: + + New parameters: domainpath + + addHost + + Response: + + New parameters: instanceconversionsupported, istagarule + + attachVolume + + Response: + + New parameters: domainpath, encryptformat, volumecheckresult, volumerepairresult + + listLoadBalancers + + Response: + + New parameters: domainpath + + updateProject + + Request: + + New parameters: name (optional) + + listVpnConnections + + Response: + + New parameters: domainpath + + updateVlanIpRange + + Response: + + New parameters: domainpath + + listResourceLimits + + Response: + + New parameters: domainpath + + listIsos + + Request: + + New parameters: imagestoreid (optional), storageid (optional) + + Response: + + New parameters: domainpath + + listAutoScalePolicies + + Response: + + New parameters: domainpath + + updateRole + + Request: + + New parameters: ispublic (optional) + + listZones + + Request: + + New parameters: ids (optional) + + listRemoteAccessVpns + + Response: + + New parameters: domainpath + + createServiceInstance + + Response: + + New parameters: domainpath + + listNetscalerLoadBalancerNetworks + + Response: + + New parameters: domainpath + + startSystemVm + + Response: + + New parameters: serviceofferingid, serviceofferingname + + declareHostAsDegraded + + Response: + + New parameters: instanceconversionsupported, istagarule + + createKubernetesCluster + + Request: + + New parameters: clustertype (optional) + + Changed parameters: description (old version - required, new version - optional), kubernetesversionid (old version - required, new version - optional), size (old version - required, new version - optional), serviceofferingid (old version - required, new version - optional) + + Response: + + New parameters: clustertype, domainpath + + configureVirtualRouterElement + + Response: + + New parameters: domainpath + + migrateVolume + + Response: + + New parameters: domainpath, encryptformat, volumecheckresult, volumerepairresult + + listEvents + + Request: + + New parameters: archived (optional) + + Response: + + New parameters: archived, domainpath + + updateVMAffinityGroup + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + migrateVPC + + Response: + + New parameters: domainpath + + dedicatePublicIpRange + + Response: + + New parameters: domainpath + + recoverVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + getUploadParamsForTemplate + + Request: + + Changed parameters: displaytext (old version - required, new version - optional) + + revertSnapshot + + Response: + + New parameters: datastoreid, datastorename, datastorestate, datastoretype, domainpath, downloaddetails, status, volumestate, zonename + + migrateSystemVm + + Response: + + New parameters: serviceofferingid, serviceofferingname + + listVirtualRouterElements + + Response: + + New parameters: domainpath + + linkAccountToLdap + + Request: + + New parameters: roleid (optional) + + Changed parameters: accounttype (old version - required, new version - optional) + + listAutoScaleVmProfiles + + Response: + + New parameters: domainpath, userdatadetails, userdataid, userdataname, userdatapolicy + + cancelHostAsDegraded + + Response: + + New parameters: instanceconversionsupported, istagarule + + syncStoragePool + + Response: + + New parameters: istagarule, managed, nfsmountopts, storagecustomstats + + createSecurityGroup + + Response: + + New parameters: domainpath + + listVpnGateways + + Response: + + New parameters: domainpath + + updateResourceCount + + Response: + + New parameters: domainpath + + listRouters + + Response: + + New parameters: domainpath + + createVpnConnection + + Response: + + New parameters: domainpath + + listBrocadeVcsDeviceNetworks + + Response: + + New parameters: domainpath + + importRole + + Request: + + New parameters: ispublic (optional) + + listKubernetesSupportedVersions + + Response: + + New parameters: directdownload + + listInfrastructure + + Response: + + New parameters: objectstores + + listUsageRecords + + Response: + + New parameters: domainpath + + recoverVolume + + Response: + + New parameters: domainpath, encryptformat, volumecheckresult, volumerepairresult + + listZonesMetrics + + Request: + + New parameters: ids (optional) + + updateIpAddress + + Response: + + New parameters: domainpath, hasrules, virtualmachinetype + + migrateNetwork + + Response: + + New parameters: domainpath + + listUnmanagedInstances + + Response: + + New parameters: clustername + + registerTemplate + + Request: + + New parameters: templatetype (optional) + + Changed parameters: displaytext (old version - required, new version - optional) + + Response: + + New parameters: domainpath + + findStoragePoolsForMigration + + Response: + + New parameters: istagarule, managed, nfsmountopts, storagecustomstats + + createStoragePool + + Request: + + New parameters: istagarule (optional) + + Response: + + New parameters: istagarule, managed, nfsmountopts, storagecustomstats + + configureOvsElement + + Response: + + New parameters: domainpath + + importUnmanagedInstance + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + listAutoScaleVmGroups + + Response: + + New parameters: domainpath + + createVolume + + Response: + + New parameters: domainpath, encryptformat, volumecheckresult, volumerepairresult + + listVMSnapshot + + Response: + + New parameters: domainpath + + attachIso + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + disassociateIpAddress + + Request: + + New parameters: ipaddress (optional) + + Changed parameters: id (old version - required, new version - optional) + + enableStorageMaintenance + + Response: + + New parameters: istagarule, managed, nfsmountopts, storagecustomstats + + createVpnGateway + + Response: + + New parameters: domainpath + + createVMSnapshot + + Response: + + New parameters: domainpath + + listVpnUsers + + Response: + + New parameters: domainpath + + cancelStorageMaintenance + + Response: + + New parameters: istagarule, managed, nfsmountopts, storagecustomstats + + destroyRouter + + Response: + + New parameters: domainpath + + updateSnapshotPolicy + + Response: + + New parameters: zone + + queryAsyncJobResult + + Response: + + New parameters: account, domainid, domainpath, managementserverid + + removeNicFromVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + getUploadParamsForIso + + Request: + + Changed parameters: displaytext (old version - required, new version - optional) + + updateLoadBalancerRule + + Response: + + New parameters: domainpath + + createAutoScaleVmProfile + + Request: + + New parameters: userdatadetails (optional), userdataid (optional) + + Response: + + New parameters: domainpath, userdatadetails, userdataid, userdataname, userdatapolicy + + startKubernetesCluster + + Response: + + New parameters: clustertype, domainpath + + reconnectHost + + Response: + + New parameters: instanceconversionsupported, istagarule + + createInstanceGroup + + Response: + + New parameters: domainpath + + createLoadBalancer + + Response: + + New parameters: domainpath + + createPrivateGateway + + Response: + + New parameters: domainpath + + listLoadBalancerRules + + Response: + + New parameters: domainpath + + createVpnCustomerGateway + + Response: + + New parameters: domainpath + + addVpnUser + + Response: + + New parameters: domainpath + + addBaremetalHost + + Response: + + New parameters: instanceconversionsupported, istagarule + + updateRemoteAccessVpn + + Response: + + New parameters: domainpath + + destroyVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + listServiceOfferings + + Request: + + New parameters: account (optional), projectid (optional), state (optional), storagetype (optional) + + Response: + + New parameters: state + + startVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + updateServiceOffering + + Request: + + New parameters: state (optional) + + Response: + + New parameters: state + + stopVirtualMachine + + Response: + + New parameters: domainpath, ipaddress, templateformat, templatetype, vnfdetails, vnfnics + + createNetworkACLList + + Request: + + Changed parameters: vpcid (old version - required, new version - optional) diff --git a/diff-419-4192/diff.json b/diff-419-4192/diff.json new file mode 100644 index 0000000..0cef9b2 --- /dev/null +++ b/diff-419-4192/diff.json @@ -0,0 +1 @@ +{"commands_args_changed":[{"response":{"params_removed":[{"name":"id"},{"name":"averageload"},{"name":"capabilities"},{"name":"clusterid"},{"name":"clustername"},{"name":"clustertype"},{"name":"cpuallocated"},{"name":"cpuallocatedpercentage"},{"name":"cpuallocatedvalue"},{"name":"cpuallocatedwithoverprovisioning"},{"name":"cpunumber"},{"name":"cpuspeed"},{"name":"cpuused"},{"name":"cpuwithoverprovisioning"},{"name":"created"},{"name":"disconnected"},{"name":"disksizeallocated"},{"name":"disksizetotal"},{"name":"events"},{"name":"hahost"},{"name":"hasenoughcapacity"},{"name":"hosttags"},{"name":"hypervisor"},{"name":"hypervisorversion"},{"name":"ipaddress"},{"name":"islocalstorageactive"},{"name":"lastpinged"},{"name":"managementserverid"},{"name":"memoryallocated"},{"name":"memoryallocatedbytes"},{"name":"memoryallocatedpercentage"},{"name":"memorytotal"},{"name":"memoryused"},{"name":"memorywithoverprovisioning"},{"name":"name"},{"name":"networkkbsread"},{"name":"networkkbswrite"},{"name":"oscategoryid"},{"name":"oscategoryname"},{"name":"podid"},{"name":"podname"},{"name":"removed"},{"name":"resourcestate"},{"name":"state"},{"name":"suitableformigration"},{"name":"type"},{"name":"version"},{"name":"zoneid"},{"name":"zonename"}]},"name":"findHostsForMigration"},{"response":{"params_new":[{"name":"specifyvlan"}]},"name":"listNiciraNvpDeviceNetworks"},{"response":{"params_new":[{"name":"specifyvlan"}]},"name":"updateNetwork"},{"response":{"params_new":[{"name":"specifyvlan"}]},"name":"listNetscalerLoadBalancerNetworks"},{"response":{"params_new":[{"name":"specifyvlan"}]},"name":"listBrocadeVcsDeviceNetworks"},{"response":{"params_new":[{"name":"specifyvlan"}]},"name":"listNetworks"},{"response":{"params_new":[{"name":"specifyvlan"}]},"name":"listPaloAltoFirewallNetworks"},{"request":{"params_new":[{"name":"cidrlist","required":false}]},"name":"updatePortForwardingRule"},{"request":{"params_removed":[{"name":"keyword"},{"name":"page"},{"name":"pagesize"}],"params_new":[{"name":"batchsize","required":false},{"name":"host","required":false},{"name":"token","required":false}]},"response":{"params_removed":[{"name":"clusterid"},{"name":"clustername"},{"name":"cpucorepersocket"},{"name":"cpunumber"},{"name":"cpuspeed"},{"name":"hostid"},{"name":"hostname"},{"name":"memory"},{"name":"name"},{"name":"osdisplayname"},{"name":"osid"},{"name":"powerstate"},{"name":"disk(*)"},{"name":"nic(*)"}],"params_new":[{"name":"token"}]},"name":"listVmwareDcVms"},{"response":{"params_new":[{"name":"specifyvlan"}]},"name":"createNetwork"},{"response":{"params_new":[{"name":"specifyvlan"}]},"name":"migrateNetwork"},{"request":{"params_new":[{"name":"importinstancehostid","required":false}]},"name":"importVm"}],"commands_added":[{"name":"listVmwareDcHosts","description":"Lists the VMs in a Vmware Datacenter"}],"commands_removed":[],"commands_sync_changed":[]} \ No newline at end of file diff --git a/diff-419-4192/diff.txt b/diff-419-4192/diff.txt new file mode 100644 index 0000000..eea768c --- /dev/null +++ b/diff-419-4192/diff.txt @@ -0,0 +1,90 @@ +Added commands: + + listVmwareDcHosts (Lists the VMs in a Vmware Datacenter) + +Removed commands: + +Changes in command type (sync versus async) + + +Changes in commands arguments: + + findHostsForMigration + + Response: + + Removed parameters: id, averageload, capabilities, clusterid, clustername, clustertype, cpuallocated, cpuallocatedpercentage, cpuallocatedvalue, cpuallocatedwithoverprovisioning, cpunumber, cpuspeed, cpuused, cpuwithoverprovisioning, created, disconnected, disksizeallocated, disksizetotal, events, hahost, hasenoughcapacity, hosttags, hypervisor, hypervisorversion, ipaddress, islocalstorageactive, lastpinged, managementserverid, memoryallocated, memoryallocatedbytes, memoryallocatedpercentage, memorytotal, memoryused, memorywithoverprovisioning, name, networkkbsread, networkkbswrite, oscategoryid, oscategoryname, podid, podname, removed, resourcestate, state, suitableformigration, type, version, zoneid, zonename + + listNiciraNvpDeviceNetworks + + Response: + + New parameters: specifyvlan + + updateNetwork + + Response: + + New parameters: specifyvlan + + listNetscalerLoadBalancerNetworks + + Response: + + New parameters: specifyvlan + + listBrocadeVcsDeviceNetworks + + Response: + + New parameters: specifyvlan + + listNetworks + + Response: + + New parameters: specifyvlan + + listPaloAltoFirewallNetworks + + Response: + + New parameters: specifyvlan + + updatePortForwardingRule + + Request: + + New parameters: cidrlist (optional) + + listVmwareDcVms + + Request: + + New parameters: batchsize (optional), host (optional), token (optional) + + Removed parameters: keyword, page, pagesize + + Response: + + New parameters: token + + Removed parameters: clusterid, clustername, cpucorepersocket, cpunumber, cpuspeed, hostid, hostname, memory, name, osdisplayname, osid, powerstate, disk(*), nic(*) + + createNetwork + + Response: + + New parameters: specifyvlan + + migrateNetwork + + Response: + + New parameters: specifyvlan + + importVm + + Request: + + New parameters: importinstancehostid (optional) diff --git a/diff-419-420/diff.json b/diff-419-420/diff.json new file mode 100644 index 0000000..f64f401 --- /dev/null +++ b/diff-419-420/diff.json @@ -0,0 +1 @@ +{"commands_args_changed":[{"request":{"params_new":[{"name":"fornsx","required":false},{"name":"networkmode","required":false},{"name":"nsxsupportlb","required":false},{"name":"routingmode","required":false},{"name":"specifyasnumber","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"supportedservices"}]},"response":{"params_new":[{"name":"fornsx"},{"name":"networkmode"},{"name":"routingmode"},{"name":"specifyasnumber"}]},"name":"createVPCOffering"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"ldapCreateAccount"},{"response":{"params_new":[{"name":"arch"}]},"name":"copyIso"},{"request":{"params_new":[{"name":"tag","required":false}]},"response":{"params_new":[{"name":"tag"}]},"name":"updateResourceLimit"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"restoreVirtualMachine"},{"response":{"params_new":[{"name":"arch"},{"name":"explicithosttags"},{"name":"implicithosttags"}]},"name":"updateHost"},{"response":{"params_new":[{"name":"arch"}]},"name":"listClusters"},{"response":{"params_new":[{"name":"snapshotname"},{"name":"templatename"},{"name":"volumename"}]},"name":"listStoragePoolObjects"},{"response":{"params_new":[{"name":"asnumber"},{"name":"asnumberid"},{"name":"bgppeers"},{"name":"ip4routes"},{"name":"ip4routing"}]},"name":"updateVPC"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"updateVmNicIp"},{"response":{"params_new":[{"name":"suitableforvirtualmachine"}]},"name":"updateDiskOffering"},{"request":{"params_new":[{"name":"position","required":false}]},"response":{"params_removed":[{"name":"uuid"}],"params_new":[{"name":"id"},{"name":"position"}]},"name":"quotaTariffUpdate"},{"response":{"params_new":[{"name":"allowuserforcestopvm"},{"name":"sharedfsvmmincpucount"},{"name":"sharedfsvmminramsize"}]},"name":"listCapabilities"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"checkVolume"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"updateDomain"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"detachVolume"},{"response":{"params_new":[{"name":"explicithosttags"},{"name":"implicithosttags"}]},"name":"findHostsForMigration"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"addNicToVirtualMachine"},{"request":{"params_new":[{"name":"forsystemvms","required":false}]},"response":{"params_new":[{"name":"forsystemvms"}]},"name":"listPublicIpAddresses"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"updateDefaultNicForVirtualMachine"},{"response":{"params_new":[{"name":"arch"}]},"name":"copyTemplate"},{"response":{"params_new":[{"name":"asnumber"},{"name":"asnumberid"},{"name":"bgppeers"},{"name":"ip4routes"},{"name":"ip4routing"}]},"name":"listNiciraNvpDeviceNetworks"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"resizeVolume"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"changeOfferingForVolume"},{"response":{"params_new":[{"name":"asnumber"},{"name":"asnumberid"},{"name":"bgppeers"},{"name":"ip4routes"},{"name":"ip4routing"}]},"name":"updateNetwork"},{"response":{"params_removed":[{"name":"usagetypeid"}],"params_new":[{"name":"id"},{"name":"name"}]},"name":"listUsageTypes"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"migrateVirtualMachine"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"resetPasswordForVirtualMachine"},{"request":{"params_new":[{"name":"asnumber","required":false},{"name":"bgppeerids","required":false},{"name":"cidrsize","required":false}],"params_changed":[{"required_new":false,"required_old":true,"name":"cidr"}]},"response":{"params_new":[{"name":"asnumber"},{"name":"asnumberid"},{"name":"bgppeers"},{"name":"ip4routes"},{"name":"ip4routing"}]},"name":"createVPC"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"detachIso"},{"response":{"params_new":[{"name":"arch"},{"name":"explicithosttags"},{"name":"implicithosttags"}]},"name":"prepareHostForMaintenance"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"listVirtualMachines"},{"request":{"params_new":[{"name":"virtualmachineid","required":false}]},"response":{"params_new":[{"name":"suitableforvirtualmachine"}]},"name":"listDiskOfferings"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"listProjects"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"createAccount"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"revertToVMSnapshot"},{"request":{"params_new":[{"name":"arch","required":false}]},"response":{"params_new":[{"name":"arch"}]},"name":"registerIso"},{"response":{"params_new":[{"name":"arch"},{"name":"explicithosttags"},{"name":"implicithosttags"}]},"name":"cancelHostMaintenance"},{"response":{"params_new":[{"name":"asnrange"},{"name":"ismultiarch"},{"name":"isnsxenabled"}]},"name":"updateZone"},{"response":{"params_new":[{"name":"fornsx"}]},"name":"listVlanIpRanges"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"listProjectAccounts"},{"response":{"params_new":[{"name":"suitableforvirtualmachine"}]},"name":"createDiskOffering"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"migrateVirtualMachineWithVolume"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"attachVolume"},{"response":{"params_new":[{"name":"arch"},{"name":"explicithosttags"},{"name":"implicithosttags"}]},"name":"addHost"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"updateProject"},{"response":{"params_new":[{"name":"asnrange"},{"name":"ismultiarch"},{"name":"isnsxenabled"}]},"name":"listZones"},{"response":{"params_new":[{"name":"asnumber"},{"name":"asnumberid"},{"name":"bgppeers"},{"name":"ip4routes"},{"name":"ip4routing"}]},"name":"listNetscalerLoadBalancerNetworks"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"migrateVolume"},{"response":{"params_new":[{"name":"asnumber"},{"name":"asnumberid"},{"name":"bgppeers"},{"name":"ip4routes"},{"name":"ip4routing"}]},"name":"migrateVPC"},{"response":{"params_new":[{"name":"fornsx"}]},"name":"dedicatePublicIpRange"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"recoverVirtualMachine"},{"response":{"params_new":[{"name":"arch"},{"name":"explicithosttags"},{"name":"implicithosttags"}]},"name":"cancelHostAsDegraded"},{"response":{"params_new":[{"name":"asnumber"},{"name":"asnumberid"},{"name":"bgppeers"},{"name":"ip4routes"},{"name":"ip4routing"}]},"name":"listBrocadeVcsDeviceNetworks"},{"response":{"params_new":[{"name":"state"}]},"name":"importRole"},{"request":{"params_new":[{"name":"position","required":false}]},"response":{"params_removed":[{"name":"uuid"}],"params_new":[{"name":"id"},{"name":"position"}]},"name":"quotaTariffCreate"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"suspendProject"},{"response":{"params_new":[{"name":"asnrange"},{"name":"ismultiarch"},{"name":"isnsxenabled"}]},"name":"createZone"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"listDomainChildren"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"importUnmanagedInstance"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"attachIso"},{"request":{"params_changed":[{"required_new":false,"required_old":true,"name":"enddate"},{"required_new":false,"required_old":true,"name":"startdate"}]},"name":"generateUsageRecords"},{"request":{"params_new":[{"name":"tag","required":false}]},"response":{"params_new":[{"name":"taggedresources"}]},"name":"listAccounts"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"activateProject"},{"request":{"params_new":[{"name":"issystem","required":false}]},"name":"deleteVnfTemplate"},{"response":{"params_new":[{"name":"arch"},{"name":"explicithosttags"},{"name":"implicithosttags"}]},"name":"addBaremetalHost"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"destroyVirtualMachine"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"startVirtualMachine"},{"response":{"params_new":[{"name":"arch"},{"name":"explicithosttags"},{"name":"implicithosttags"}]},"name":"listHosts"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"moveDomain"},{"response":{"params_new":[{"name":"asnumber"},{"name":"asnumberid"},{"name":"bgppeers"},{"name":"ip4routes"},{"name":"ip4routing"}]},"name":"listNetworks"},{"response":{"params_new":[{"name":"dedicatedresources"}]},"name":"listAffinityGroups"},{"response":{"params_new":[{"name":"forsystemvms"}]},"name":"reserveIpAddress"},{"response":{"params_new":[{"name":"fornsx"},{"name":"networkmode"},{"name":"routingmode"},{"name":"specifyasnumber"}]},"name":"listVPCOfferings"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"uploadVolume"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"lockAccount"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"changeServiceForVirtualMachine"},{"request":{"params_new":[{"name":"arch","required":false}]},"response":{"params_new":[{"name":"arch"}]},"name":"listTemplates"},{"response":{"params_new":[{"name":"dedicatedresources"}]},"name":"createAffinityGroup"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"rebootVirtualMachine"},{"request":{"params_new":[{"name":"arch","required":false}]},"response":{"params_new":[{"name":"arch"}]},"name":"listVnfTemplates"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"deployVnfAppliance"},{"response":{"params_new":[{"name":"fornsx"},{"name":"networkmode"},{"name":"routingmode"},{"name":"specifyasnumber"},{"name":"supportsinternallb"}]},"name":"updateNetworkOffering"},{"request":{"params_new":[{"name":"fornsx","required":false},{"name":"networkmode","required":false},{"name":"nsxsupportlb","required":false},{"name":"nsxsupportsinternallb","required":false},{"name":"routingmode","required":false},{"name":"specifyasnumber","required":false}]},"response":{"params_new":[{"name":"fornsx"},{"name":"networkmode"},{"name":"routingmode"},{"name":"specifyasnumber"},{"name":"supportsinternallb"}]},"name":"createNetworkOffering"},{"request":{"params_new":[{"name":"id","required":false},{"name":"listonlyremoved","required":false}]},"response":{"params_removed":[{"name":"uuid"}],"params_new":[{"name":"id"},{"name":"position"}]},"name":"quotaTariffList"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"destroyVolume"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"createProject"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"markDefaultZoneForAccount"},{"response":{"params_new":[{"name":"snapshotname"},{"name":"templatename"},{"name":"volumename"}]},"name":"listImageStoreObjects"},{"request":{"params_new":[{"name":"arch","required":false}]},"response":{"params_new":[{"name":"arch"}]},"name":"updateIso"},{"response":{"params_new":[{"name":"arch"}]},"name":"prepareTemplate"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"createDomain"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"assignVolume"},{"request":{"params_new":[{"name":"purgeresources","required":false}]},"response":{"params_new":[{"name":"purgeresources"}]},"name":"createServiceOffering"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"assignVirtualMachine"},{"request":{"params_new":[{"name":"arch","required":false},{"name":"templatetag","required":false}]},"response":{"params_new":[{"name":"arch"}]},"name":"updateTemplate"},{"request":{"params_new":[{"name":"fornsx","required":false}]},"response":{"params_new":[{"name":"fornsx"}]},"name":"createVlanIpRange"},{"response":{"params_new":[{"name":"asnumber"},{"name":"asnumberid"},{"name":"bgppeers"},{"name":"ip4routes"},{"name":"ip4routing"}]},"name":"listPaloAltoFirewallNetworks"},{"request":{"params_new":[{"name":"deleteprotection","required":false}]},"response":{"params_new":[{"name":"deleteprotection"}]},"name":"updateVolume"},{"request":{"params_new":[{"name":"deleteprotection","required":false}]},"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"updateVirtualMachine"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"updateAccount"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"disableAccount"},{"request":{"params_new":[{"name":"tag","required":false}]},"response":{"params_new":[{"name":"taggedresources"}]},"name":"listDomains"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"resetUserDataForVirtualMachine"},{"request":{"params_new":[{"name":"issystem","required":false}]},"name":"deleteTemplate"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"importVolume"},{"response":{"params_new":[{"name":"arch"}]},"name":"createTemplate"},{"response":{"params_new":[{"name":"forsystemvms"}]},"name":"associateIpAddress"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"resetSSHKeyForVirtualMachine"},{"request":{"params_new":[{"name":"arch","required":false}]},"name":"addKubernetesSupportedVersion"},{"response":{"params_new":[{"name":"arch"}]},"name":"linkUserDataToTemplate"},{"response":{"params_new":[{"name":"state"}]},"name":"createRole"},{"request":{"params_new":[{"name":"arch","required":false}]},"response":{"params_new":[{"name":"arch"}]},"name":"updateCluster"},{"response":{"params_new":[{"name":"isimplicit"}]},"name":"listHostTags"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"deployVirtualMachine"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"listVolumes"},{"request":{"params_new":[{"name":"asnumber","required":false},{"name":"bgppeerids","required":false},{"name":"cidrsize","required":false}]},"response":{"params_new":[{"name":"asnumber"},{"name":"asnumberid"},{"name":"bgppeers"},{"name":"ip4routes"},{"name":"ip4routing"}]},"name":"createNetwork"},{"request":{"params_new":[{"name":"routingmode","required":false}]},"response":{"params_new":[{"name":"fornsx"},{"name":"networkmode"},{"name":"routingmode"},{"name":"specifyasnumber"},{"name":"supportsinternallb"}]},"name":"listNetworkOfferings"},{"response":{"params_new":[{"name":"asnumber"},{"name":"asnumberid"},{"name":"bgppeers"},{"name":"ip4routes"},{"name":"ip4routing"}]},"name":"listVPCs"},{"response":{"params_new":[{"name":"fornsx"}]},"name":"updateVlanIpRange"},{"request":{"params_new":[{"name":"tag","required":false}]},"response":{"params_new":[{"name":"tag"}]},"name":"listResourceLimits"},{"request":{"params_new":[{"name":"arch","required":false}]},"response":{"params_new":[{"name":"arch"}]},"name":"listIsos"},{"response":{"params_new":[{"name":"state"}]},"name":"updateRole"},{"request":{"params_new":[{"name":"arch","required":false}]},"response":{"params_new":[{"name":"arch"}]},"name":"registerVnfTemplate"},{"response":{"params_new":[{"name":"arch"},{"name":"explicithosttags"},{"name":"implicithosttags"}]},"name":"declareHostAsDegraded"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"updateVMAffinityGroup"},{"request":{"params_new":[{"name":"arch","required":false}]},"name":"getUploadParamsForTemplate"},{"request":{"params_new":[{"name":"tag","required":false}]},"response":{"params_new":[{"name":"tag"}]},"name":"updateResourceCount"},{"request":{"params_new":[{"name":"state","required":false}]},"response":{"params_new":[{"name":"state"}]},"name":"listRoles"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"recoverVolume"},{"response":{"params_new":[{"name":"forsystemvms"}]},"name":"updateIpAddress"},{"response":{"params_new":[{"name":"asnumber"},{"name":"asnumberid"},{"name":"bgppeers"},{"name":"ip4routes"},{"name":"ip4routing"}]},"name":"migrateNetwork"},{"request":{"params_new":[{"name":"arch","required":false}]},"response":{"params_new":[{"name":"arch"}]},"name":"registerTemplate"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"listVnfAppliances"},{"response":{"params_new":[{"name":"deleteprotection"}]},"name":"createVolume"},{"response":{"params_removed":[{"name":"id"},{"name":"created"},{"name":"description"},{"name":"heuristicrule"},{"name":"name"},{"name":"removed"},{"name":"type"},{"name":"zoneid"}],"params_new":[{"name":"displaytext"},{"name":"success"}]},"name":"removeSecondaryStorageSelector"},{"request":{"params_new":[{"name":"arch","required":false}]},"response":{"params_new":[{"name":"arch"}]},"name":"addCluster"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"removeNicFromVirtualMachine"},{"response":{"params_new":[{"name":"taggedresources"}]},"name":"enableAccount"},{"response":{"params_new":[{"name":"arch"},{"name":"explicithosttags"},{"name":"implicithosttags"}]},"name":"reconnectHost"},{"request":{"params_new":[{"name":"arch","required":false},{"name":"templatetag","required":false}]},"response":{"params_new":[{"name":"arch"}]},"name":"updateVnfTemplate"},{"response":{"params_new":[{"name":"fornsx"},{"name":"networkmode"},{"name":"routingmode"},{"name":"specifyasnumber"}]},"name":"updateVPCOffering"},{"request":{"params_new":[{"name":"templateid","required":false}]},"response":{"params_new":[{"name":"purgeresources"}]},"name":"listServiceOfferings"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"importVm"},{"request":{"params_new":[{"name":"tag","required":false}]},"response":{"params_new":[{"name":"tag"}]},"name":"listCapacity"},{"response":{"params_new":[{"name":"deleteprotection"},{"name":"vmtype"}]},"name":"stopVirtualMachine"},{"request":{"params_new":[{"name":"purgeresources","required":false}]},"response":{"params_new":[{"name":"purgeresources"}]},"name":"updateServiceOffering"}],"commands_added":[{"name":"changeBgpPeersForNetwork","description":"Change the BGP peers for a network."},{"name":"enableRole","description":"Enables a role"},{"name":"updateSharedFileSystem","description":"Update a Shared FileSystem"},{"name":"updateIpv4SubnetForZone","description":"Updates an existing IPv4 subnet for a zone."},{"name":"listASNumbers","description":"List Autonomous Systems Numbers"},{"name":"updateRoutingFirewallRule","description":"Updates Routing firewall rule with specified ID"},{"name":"quotaListEmailConfiguration","description":"List quota email template configurations"},{"name":"deleteBackupRepository","description":"delete a backup repository"},{"name":"changeBgpPeersForVpc","description":"Change the BGP peers for a VPC."},{"name":"createSharedFileSystem","description":"Create a new Shared File System of specified size and disk offering, attached to the given network"},{"name":"quotaPresetVariablesList","description":"List the preset variables available for using in the Quota tariff activation rules given the usage type."},{"name":"addNsxController","description":"Add NSX Controller to CloudStack"},{"name":"purgeExpungedResources","description":"Purge expunged resources"},{"name":"deleteNsxController","description":"delete NSX Controller to CloudStack"},{"name":"listWebhooks","description":"Lists Webhooks"},{"name":"executeWebhookDelivery","description":"Executes a Webhook delivery"},{"name":"recoverSharedFileSystem","description":"Recover a Shared FileSystem by id"},{"name":"listIpv4SubnetsForGuestNetwork","description":"Lists IPv4 subnets for guest networks."},{"name":"releaseIpv4SubnetForZone","description":"Releases an existing dedicated IPv4 subnet for a zone."},{"name":"createIpv4SubnetForZone","description":"Creates a IPv4 subnet for a zone."},{"name":"listNetworkProtocols","description":"Lists details of network protocols"},{"name":"createASNRange","description":"Creates a range of Autonomous Systems for BGP Dynamic Routing"},{"name":"deleteBgpPeer","description":"Deletes an existing Bgp Peer."},{"name":"updateBgpPeer","description":"Updates an existing Bgp Peer."},{"name":"deleteIpv4SubnetForGuestNetwork","description":"Deletes an existing IPv4 subnet for guest network."},{"name":"createRoutingFirewallRule","description":"Creates a routing firewall rule in the given network in ROUTED mode"},{"name":"releaseASNumber","description":"Releases an AS Number back to the pool"},{"name":"listWebhookDeliveries","description":"Lists Webhook deliveries"},{"name":"restartSharedFileSystem","description":"Restart a Shared FileSystem"},{"name":"forgotPassword","description":"Sends an email to the user with a token to reset the password using resetPassword command."},{"name":"listASNRanges","description":"List Autonomous Systems Number Ranges"},{"name":"resetPassword","description":"Resets the password for the user using the token generated via forgotPassword command."},{"name":"disableRole","description":"Disables a role"},{"name":"listBackupRepositories","description":"Lists all backup repositories"},{"name":"createBgpPeer","description":"Creates a Bgp Peer for a zone."},{"name":"dedicateBgpPeer","description":"Dedicates an existing Bgp Peer to an account or a domain."},{"name":"createIpv4SubnetForGuestNetwork","description":"Creates a IPv4 subnet for guest networks."},{"name":"destroySharedFileSystem","description":"Destroy a Shared FileSystem by id"},{"name":"deleteASNRange","description":"deletes a range of Autonomous Systems for BGP Dynamic Routing"},{"name":"listRoutingFirewallRules","description":"Lists all Routing firewall rules"},{"name":"listIpv4SubnetsForZone","description":"Lists IPv4 subnets for zone."},{"name":"startSharedFileSystem","description":"Start a Shared FileSystem"},{"name":"addBackupRepository","description":"Adds a backup repository to store NAS backups"},{"name":"stopSharedFileSystem","description":"Stop a Shared FileSystem"},{"name":"deleteRoutingFirewallRule","description":"Deletes a routing firewall rule"},{"name":"listBgpPeers","description":"Lists Bgp Peers."},{"name":"listNsxControllers","description":"list all NSX controllers added to CloudStack"},{"name":"releaseBgpPeer","description":"Releases an existing dedicated Bgp Peer."},{"name":"deleteIpv4SubnetForZone","description":"Deletes an existing IPv4 subnet for a zone."},{"name":"deleteWebhookDelivery","description":"Deletes Webhook delivery"},{"name":"changeSharedFileSystemServiceOffering","description":"Change Service offering of a Shared FileSystem"},{"name":"quotaConfigureEmail","description":"Configure a quota email template"},{"name":"dedicateIpv4SubnetForZone","description":"Dedicates an existing IPv4 subnet for a zone to an account or a domain."},{"name":"listSharedFileSystems","description":"List Shared FileSystems"},{"name":"deleteWebhook","description":"Deletes a Webhook"},{"name":"updateWebhook","description":"Updates a Webhook"},{"name":"changeSharedFileSystemDiskOffering","description":"Change Disk offering of a Shared FileSystem"},{"name":"expungeSharedFileSystem","description":"Expunge a Shared FileSystem by id"},{"name":"createWebhook","description":"Creates a Webhook"},{"name":"extractSnapshot","description":"Returns a download URL for extracting a snapshot. It must be in the Backed Up state."},{"name":"listSharedFileSystemProviders","description":"Lists all available shared filesystem providers."}],"commands_removed":[],"commands_sync_changed":[]} \ No newline at end of file diff --git a/diff-419-420/diff.txt b/diff-419-420/diff.txt new file mode 100644 index 0000000..214330b --- /dev/null +++ b/diff-419-420/diff.txt @@ -0,0 +1,1162 @@ +Added commands: + + changeBgpPeersForNetwork (Change the BGP peers for a network.) + + enableRole (Enables a role) + + updateSharedFileSystem (Update a Shared FileSystem) + + updateIpv4SubnetForZone (Updates an existing IPv4 subnet for a zone.) + + listASNumbers (List Autonomous Systems Numbers) + + updateRoutingFirewallRule (Updates Routing firewall rule with specified ID) + + quotaListEmailConfiguration (List quota email template configurations) + + deleteBackupRepository (delete a backup repository) + + changeBgpPeersForVpc (Change the BGP peers for a VPC.) + + createSharedFileSystem (Create a new Shared File System of specified size and disk offering, attached to the given network) + + quotaPresetVariablesList (List the preset variables available for using in the Quota tariff activation rules given the usage type.) + + addNsxController (Add NSX Controller to CloudStack) + + purgeExpungedResources (Purge expunged resources) + + deleteNsxController (delete NSX Controller to CloudStack) + + listWebhooks (Lists Webhooks) + + executeWebhookDelivery (Executes a Webhook delivery) + + recoverSharedFileSystem (Recover a Shared FileSystem by id) + + listIpv4SubnetsForGuestNetwork (Lists IPv4 subnets for guest networks.) + + releaseIpv4SubnetForZone (Releases an existing dedicated IPv4 subnet for a zone.) + + createIpv4SubnetForZone (Creates a IPv4 subnet for a zone.) + + listNetworkProtocols (Lists details of network protocols) + + createASNRange (Creates a range of Autonomous Systems for BGP Dynamic Routing) + + deleteBgpPeer (Deletes an existing Bgp Peer.) + + updateBgpPeer (Updates an existing Bgp Peer.) + + deleteIpv4SubnetForGuestNetwork (Deletes an existing IPv4 subnet for guest network.) + + createRoutingFirewallRule (Creates a routing firewall rule in the given network in ROUTED mode) + + releaseASNumber (Releases an AS Number back to the pool) + + listWebhookDeliveries (Lists Webhook deliveries) + + restartSharedFileSystem (Restart a Shared FileSystem) + + forgotPassword (Sends an email to the user with a token to reset the password using resetPassword command.) + + listASNRanges (List Autonomous Systems Number Ranges) + + resetPassword (Resets the password for the user using the token generated via forgotPassword command.) + + disableRole (Disables a role) + + listBackupRepositories (Lists all backup repositories) + + createBgpPeer (Creates a Bgp Peer for a zone.) + + dedicateBgpPeer (Dedicates an existing Bgp Peer to an account or a domain.) + + createIpv4SubnetForGuestNetwork (Creates a IPv4 subnet for guest networks.) + + destroySharedFileSystem (Destroy a Shared FileSystem by id) + + deleteASNRange (deletes a range of Autonomous Systems for BGP Dynamic Routing) + + listRoutingFirewallRules (Lists all Routing firewall rules) + + listIpv4SubnetsForZone (Lists IPv4 subnets for zone.) + + startSharedFileSystem (Start a Shared FileSystem) + + addBackupRepository (Adds a backup repository to store NAS backups) + + stopSharedFileSystem (Stop a Shared FileSystem) + + deleteRoutingFirewallRule (Deletes a routing firewall rule) + + listBgpPeers (Lists Bgp Peers.) + + listNsxControllers (list all NSX controllers added to CloudStack) + + releaseBgpPeer (Releases an existing dedicated Bgp Peer.) + + deleteIpv4SubnetForZone (Deletes an existing IPv4 subnet for a zone.) + + deleteWebhookDelivery (Deletes Webhook delivery) + + changeSharedFileSystemServiceOffering (Change Service offering of a Shared FileSystem) + + quotaConfigureEmail (Configure a quota email template) + + dedicateIpv4SubnetForZone (Dedicates an existing IPv4 subnet for a zone to an account or a domain.) + + listSharedFileSystems (List Shared FileSystems) + + deleteWebhook (Deletes a Webhook) + + updateWebhook (Updates a Webhook) + + changeSharedFileSystemDiskOffering (Change Disk offering of a Shared FileSystem) + + expungeSharedFileSystem (Expunge a Shared FileSystem by id) + + createWebhook (Creates a Webhook) + + extractSnapshot (Returns a download URL for extracting a snapshot. It must be in the Backed Up state.) + + listSharedFileSystemProviders (Lists all available shared filesystem providers.) + +Removed commands: + +Changes in command type (sync versus async) + + +Changes in commands arguments: + + createVPCOffering + + Request: + + New parameters: fornsx (optional), networkmode (optional), nsxsupportlb (optional), routingmode (optional), specifyasnumber (optional) + + Changed parameters: supportedservices (old version - required, new version - optional) + + Response: + + New parameters: fornsx, networkmode, routingmode, specifyasnumber + + ldapCreateAccount + + Response: + + New parameters: taggedresources + + copyIso + + Response: + + New parameters: arch + + updateResourceLimit + + Request: + + New parameters: tag (optional) + + Response: + + New parameters: tag + + restoreVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + updateHost + + Response: + + New parameters: arch, explicithosttags, implicithosttags + + listClusters + + Response: + + New parameters: arch + + listStoragePoolObjects + + Response: + + New parameters: snapshotname, templatename, volumename + + updateVPC + + Response: + + New parameters: asnumber, asnumberid, bgppeers, ip4routes, ip4routing + + updateVmNicIp + + Response: + + New parameters: deleteprotection, vmtype + + updateDiskOffering + + Response: + + New parameters: suitableforvirtualmachine + + quotaTariffUpdate + + Request: + + New parameters: position (optional) + + Response: + + New parameters: id, position + + Removed parameters: uuid + + listCapabilities + + Response: + + New parameters: allowuserforcestopvm, sharedfsvmmincpucount, sharedfsvmminramsize + + checkVolume + + Response: + + New parameters: deleteprotection + + updateDomain + + Response: + + New parameters: taggedresources + + detachVolume + + Response: + + New parameters: deleteprotection + + findHostsForMigration + + Response: + + New parameters: explicithosttags, implicithosttags + + addNicToVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + listPublicIpAddresses + + Request: + + New parameters: forsystemvms (optional) + + Response: + + New parameters: forsystemvms + + updateDefaultNicForVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + copyTemplate + + Response: + + New parameters: arch + + listNiciraNvpDeviceNetworks + + Response: + + New parameters: asnumber, asnumberid, bgppeers, ip4routes, ip4routing + + resizeVolume + + Response: + + New parameters: deleteprotection + + changeOfferingForVolume + + Response: + + New parameters: deleteprotection + + updateNetwork + + Response: + + New parameters: asnumber, asnumberid, bgppeers, ip4routes, ip4routing + + listUsageTypes + + Response: + + New parameters: id, name + + Removed parameters: usagetypeid + + migrateVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + resetPasswordForVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + createVPC + + Request: + + New parameters: asnumber (optional), bgppeerids (optional), cidrsize (optional) + + Changed parameters: cidr (old version - required, new version - optional) + + Response: + + New parameters: asnumber, asnumberid, bgppeers, ip4routes, ip4routing + + detachIso + + Response: + + New parameters: deleteprotection, vmtype + + prepareHostForMaintenance + + Response: + + New parameters: arch, explicithosttags, implicithosttags + + listVirtualMachines + + Response: + + New parameters: deleteprotection, vmtype + + listDiskOfferings + + Request: + + New parameters: virtualmachineid (optional) + + Response: + + New parameters: suitableforvirtualmachine + + listProjects + + Response: + + New parameters: taggedresources + + createAccount + + Response: + + New parameters: taggedresources + + revertToVMSnapshot + + Response: + + New parameters: deleteprotection, vmtype + + registerIso + + Request: + + New parameters: arch (optional) + + Response: + + New parameters: arch + + cancelHostMaintenance + + Response: + + New parameters: arch, explicithosttags, implicithosttags + + updateZone + + Response: + + New parameters: asnrange, ismultiarch, isnsxenabled + + listVlanIpRanges + + Response: + + New parameters: fornsx + + listProjectAccounts + + Response: + + New parameters: taggedresources + + createDiskOffering + + Response: + + New parameters: suitableforvirtualmachine + + migrateVirtualMachineWithVolume + + Response: + + New parameters: deleteprotection, vmtype + + attachVolume + + Response: + + New parameters: deleteprotection + + addHost + + Response: + + New parameters: arch, explicithosttags, implicithosttags + + updateProject + + Response: + + New parameters: taggedresources + + listZones + + Response: + + New parameters: asnrange, ismultiarch, isnsxenabled + + listNetscalerLoadBalancerNetworks + + Response: + + New parameters: asnumber, asnumberid, bgppeers, ip4routes, ip4routing + + migrateVolume + + Response: + + New parameters: deleteprotection + + migrateVPC + + Response: + + New parameters: asnumber, asnumberid, bgppeers, ip4routes, ip4routing + + dedicatePublicIpRange + + Response: + + New parameters: fornsx + + recoverVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + cancelHostAsDegraded + + Response: + + New parameters: arch, explicithosttags, implicithosttags + + listBrocadeVcsDeviceNetworks + + Response: + + New parameters: asnumber, asnumberid, bgppeers, ip4routes, ip4routing + + importRole + + Response: + + New parameters: state + + quotaTariffCreate + + Request: + + New parameters: position (optional) + + Response: + + New parameters: id, position + + Removed parameters: uuid + + suspendProject + + Response: + + New parameters: taggedresources + + createZone + + Response: + + New parameters: asnrange, ismultiarch, isnsxenabled + + listDomainChildren + + Response: + + New parameters: taggedresources + + importUnmanagedInstance + + Response: + + New parameters: deleteprotection, vmtype + + attachIso + + Response: + + New parameters: deleteprotection, vmtype + + generateUsageRecords + + Request: + + Changed parameters: enddate (old version - required, new version - optional), startdate (old version - required, new version - optional) + + listAccounts + + Request: + + New parameters: tag (optional) + + Response: + + New parameters: taggedresources + + activateProject + + Response: + + New parameters: taggedresources + + deleteVnfTemplate + + Request: + + New parameters: issystem (optional) + + addBaremetalHost + + Response: + + New parameters: arch, explicithosttags, implicithosttags + + destroyVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + startVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + listHosts + + Response: + + New parameters: arch, explicithosttags, implicithosttags + + moveDomain + + Response: + + New parameters: taggedresources + + listNetworks + + Response: + + New parameters: asnumber, asnumberid, bgppeers, ip4routes, ip4routing + + listAffinityGroups + + Response: + + New parameters: dedicatedresources + + reserveIpAddress + + Response: + + New parameters: forsystemvms + + listVPCOfferings + + Response: + + New parameters: fornsx, networkmode, routingmode, specifyasnumber + + uploadVolume + + Response: + + New parameters: deleteprotection + + lockAccount + + Response: + + New parameters: taggedresources + + changeServiceForVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + listTemplates + + Request: + + New parameters: arch (optional) + + Response: + + New parameters: arch + + createAffinityGroup + + Response: + + New parameters: dedicatedresources + + rebootVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + listVnfTemplates + + Request: + + New parameters: arch (optional) + + Response: + + New parameters: arch + + deployVnfAppliance + + Response: + + New parameters: deleteprotection, vmtype + + updateNetworkOffering + + Response: + + New parameters: fornsx, networkmode, routingmode, specifyasnumber, supportsinternallb + + createNetworkOffering + + Request: + + New parameters: fornsx (optional), networkmode (optional), nsxsupportlb (optional), nsxsupportsinternallb (optional), routingmode (optional), specifyasnumber (optional) + + Response: + + New parameters: fornsx, networkmode, routingmode, specifyasnumber, supportsinternallb + + quotaTariffList + + Request: + + New parameters: id (optional), listonlyremoved (optional) + + Response: + + New parameters: id, position + + Removed parameters: uuid + + destroyVolume + + Response: + + New parameters: deleteprotection + + createProject + + Response: + + New parameters: taggedresources + + markDefaultZoneForAccount + + Response: + + New parameters: taggedresources + + listImageStoreObjects + + Response: + + New parameters: snapshotname, templatename, volumename + + updateIso + + Request: + + New parameters: arch (optional) + + Response: + + New parameters: arch + + prepareTemplate + + Response: + + New parameters: arch + + createDomain + + Response: + + New parameters: taggedresources + + assignVolume + + Response: + + New parameters: deleteprotection + + createServiceOffering + + Request: + + New parameters: purgeresources (optional) + + Response: + + New parameters: purgeresources + + assignVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + updateTemplate + + Request: + + New parameters: arch (optional), templatetag (optional) + + Response: + + New parameters: arch + + createVlanIpRange + + Request: + + New parameters: fornsx (optional) + + Response: + + New parameters: fornsx + + listPaloAltoFirewallNetworks + + Response: + + New parameters: asnumber, asnumberid, bgppeers, ip4routes, ip4routing + + updateVolume + + Request: + + New parameters: deleteprotection (optional) + + Response: + + New parameters: deleteprotection + + updateVirtualMachine + + Request: + + New parameters: deleteprotection (optional) + + Response: + + New parameters: deleteprotection, vmtype + + updateAccount + + Response: + + New parameters: taggedresources + + disableAccount + + Response: + + New parameters: taggedresources + + listDomains + + Request: + + New parameters: tag (optional) + + Response: + + New parameters: taggedresources + + resetUserDataForVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + deleteTemplate + + Request: + + New parameters: issystem (optional) + + importVolume + + Response: + + New parameters: deleteprotection + + createTemplate + + Response: + + New parameters: arch + + associateIpAddress + + Response: + + New parameters: forsystemvms + + resetSSHKeyForVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + addKubernetesSupportedVersion + + Request: + + New parameters: arch (optional) + + linkUserDataToTemplate + + Response: + + New parameters: arch + + createRole + + Response: + + New parameters: state + + updateCluster + + Request: + + New parameters: arch (optional) + + Response: + + New parameters: arch + + listHostTags + + Response: + + New parameters: isimplicit + + deployVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + listVolumes + + Response: + + New parameters: deleteprotection + + createNetwork + + Request: + + New parameters: asnumber (optional), bgppeerids (optional), cidrsize (optional) + + Response: + + New parameters: asnumber, asnumberid, bgppeers, ip4routes, ip4routing + + listNetworkOfferings + + Request: + + New parameters: routingmode (optional) + + Response: + + New parameters: fornsx, networkmode, routingmode, specifyasnumber, supportsinternallb + + listVPCs + + Response: + + New parameters: asnumber, asnumberid, bgppeers, ip4routes, ip4routing + + updateVlanIpRange + + Response: + + New parameters: fornsx + + listResourceLimits + + Request: + + New parameters: tag (optional) + + Response: + + New parameters: tag + + listIsos + + Request: + + New parameters: arch (optional) + + Response: + + New parameters: arch + + updateRole + + Response: + + New parameters: state + + registerVnfTemplate + + Request: + + New parameters: arch (optional) + + Response: + + New parameters: arch + + declareHostAsDegraded + + Response: + + New parameters: arch, explicithosttags, implicithosttags + + updateVMAffinityGroup + + Response: + + New parameters: deleteprotection, vmtype + + getUploadParamsForTemplate + + Request: + + New parameters: arch (optional) + + updateResourceCount + + Request: + + New parameters: tag (optional) + + Response: + + New parameters: tag + + listRoles + + Request: + + New parameters: state (optional) + + Response: + + New parameters: state + + recoverVolume + + Response: + + New parameters: deleteprotection + + updateIpAddress + + Response: + + New parameters: forsystemvms + + migrateNetwork + + Response: + + New parameters: asnumber, asnumberid, bgppeers, ip4routes, ip4routing + + registerTemplate + + Request: + + New parameters: arch (optional) + + Response: + + New parameters: arch + + listVnfAppliances + + Response: + + New parameters: deleteprotection, vmtype + + createVolume + + Response: + + New parameters: deleteprotection + + removeSecondaryStorageSelector + + Response: + + New parameters: displaytext, success + + Removed parameters: id, created, description, heuristicrule, name, removed, type, zoneid + + addCluster + + Request: + + New parameters: arch (optional) + + Response: + + New parameters: arch + + removeNicFromVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + enableAccount + + Response: + + New parameters: taggedresources + + reconnectHost + + Response: + + New parameters: arch, explicithosttags, implicithosttags + + updateVnfTemplate + + Request: + + New parameters: arch (optional), templatetag (optional) + + Response: + + New parameters: arch + + updateVPCOffering + + Response: + + New parameters: fornsx, networkmode, routingmode, specifyasnumber + + listServiceOfferings + + Request: + + New parameters: templateid (optional) + + Response: + + New parameters: purgeresources + + importVm + + Response: + + New parameters: deleteprotection, vmtype + + listCapacity + + Request: + + New parameters: tag (optional) + + Response: + + New parameters: tag + + stopVirtualMachine + + Response: + + New parameters: deleteprotection, vmtype + + updateServiceOffering + + Request: + + New parameters: purgeresources (optional) + + Response: + + New parameters: purgeresources diff --git a/diff-4191-4192/diff.json b/diff-4191-4192/diff.json new file mode 100644 index 0000000..a274082 --- /dev/null +++ b/diff-4191-4192/diff.json @@ -0,0 +1 @@ +{"commands_args_changed":[],"commands_added":[],"commands_removed":[],"commands_sync_changed":[]} \ No newline at end of file diff --git a/diff-4191-4192/diff.txt b/diff-4191-4192/diff.txt new file mode 100644 index 0000000..d33ac57 --- /dev/null +++ b/diff-4191-4192/diff.txt @@ -0,0 +1,8 @@ +Added commands: + +Removed commands: + +Changes in command type (sync versus async) + + +Changes in commands arguments: diff --git a/diff-4192-4193/diff.json b/diff-4192-4193/diff.json new file mode 100644 index 0000000..a807f93 --- /dev/null +++ b/diff-4192-4193/diff.json @@ -0,0 +1 @@ +{"commands_args_changed":[{"request":{"params_new":[{"name":"userdataid","required":false}]},"name":"listVirtualMachines"},{"request":{"params_new":[{"name":"userdataid","required":false}]},"name":"listVirtualMachinesMetrics"},{"response":{"params_new":[{"name":"bootmode"},{"name":"boottype"}]},"name":"listVmsForImport"},{"request":{"params_removed":[{"name":"batchsize"},{"name":"host"},{"name":"token"}],"params_new":[{"name":"hostname","required":false},{"name":"instancename","required":false}]},"response":{"params_removed":[{"name":"token"}],"params_new":[{"name":"bootmode"},{"name":"boottype"},{"name":"clusterid"},{"name":"clustername"},{"name":"cpucorepersocket"},{"name":"cpunumber"},{"name":"cpuspeed"},{"name":"hostid"},{"name":"hostname"},{"name":"memory"},{"name":"name"},{"name":"osdisplayname"},{"name":"osid"},{"name":"powerstate"},{"name":"disk(*)"},{"name":"nic(*)"}]},"name":"listVmwareDcVms"},{"response":{"params_new":[{"name":"bootmode"},{"name":"boottype"}]},"name":"listUnmanagedInstances"},{"request":{"params_new":[{"name":"userdataid","required":false}]},"name":"listVnfAppliances"}],"commands_added":[],"commands_removed":[{"name":"listVmwareDcHosts","description":"Lists the VMs in a Vmware Datacenter"}],"commands_sync_changed":[]} \ No newline at end of file diff --git a/diff-4192-4193/diff.txt b/diff-4192-4193/diff.txt new file mode 100644 index 0000000..11bcbdd --- /dev/null +++ b/diff-4192-4193/diff.txt @@ -0,0 +1,54 @@ +Added commands: + +Removed commands: + + listVmwareDcHosts (Lists the VMs in a Vmware Datacenter) + +Changes in command type (sync versus async) + + +Changes in commands arguments: + + listVirtualMachines + + Request: + + New parameters: userdataid (optional) + + listVirtualMachinesMetrics + + Request: + + New parameters: userdataid (optional) + + listVmsForImport + + Response: + + New parameters: bootmode, boottype + + listVmwareDcVms + + Request: + + New parameters: hostname (optional), instancename (optional) + + Removed parameters: batchsize, host, token + + Response: + + New parameters: bootmode, boottype, clusterid, clustername, cpucorepersocket, cpunumber, cpuspeed, hostid, hostname, memory, name, osdisplayname, osid, powerstate, disk(*), nic(*) + + Removed parameters: token + + listUnmanagedInstances + + Response: + + New parameters: bootmode, boottype + + listVnfAppliances + + Request: + + New parameters: userdataid (optional)